meshtastic 0.0.179 → 0.0.181

data/lib/meshtastic/position.rb

@@ -4,7 +4,7 @@ require 'meshtastic/mesh_pb'
 
 module Meshtastic
   class Position
-    def self.build(opts = {})
+    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
@@ -13,7 +13,7 @@ module Meshtastic
       position
     end
 
-    def self.transmit(opts = {})
+    public_class_method def self.transmit(opts = {})
       data = Meshtastic::Data.new(
         portnum: :POSITION_APP,
         payload: build(opts).to_proto
@@ -21,14 +21,24 @@ module Meshtastic
       Meshtastic.deliver_data(opts.merge(data: data, port_num: Meshtastic::PortNum::POSITION_APP))
     end
 
-    def self.authors
+    public_class_method def self.authors
       "AUTHOR(S):\n        0day Inc. <support@0dayinc.com>\n      "
     end
 
-    def self.help
-      puts "USAGE:
-        #{self}.transmit(serial_obj: serial_obj, lat: 37.7749, lon: -122.4194, altitude: 10)
+    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

data/lib/meshtastic/remote_hardware.rb

@@ -4,7 +4,7 @@ require 'meshtastic/mesh_pb'
 
 module Meshtastic
   module RemoteHardware
-    def self.encode(opts = {})
+    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)
@@ -12,7 +12,7 @@ module Meshtastic
       message
     end
 
-    def self.send(opts = {})
+    public_class_method def self.send(opts = {})
       data = Meshtastic::Data.new(
         portnum: :REMOTE_HARDWARE_APP,
         payload: encode(opts).to_proto,
@@ -21,28 +21,44 @@ module Meshtastic
       Meshtastic.deliver_data(opts.merge(data: data, port_num: Meshtastic::PortNum::REMOTE_HARDWARE_APP))
     end
 
-    def self.read_gpios(opts = {})
+    public_class_method def self.read_gpios(opts = {})
       send(opts.merge(type: :READ_GPIOS))
     end
 
-    def self.write_gpios(opts = {})
+    public_class_method def self.write_gpios(opts = {})
       send(opts.merge(type: :WRITE_GPIOS, want_response: false))
     end
 
-    def self.watch_gpios(opts = {})
+    public_class_method def self.watch_gpios(opts = {})
       send(opts.merge(type: :WATCH_GPIOS))
     end
 
-    def self.authors
+    public_class_method def self.authors
       "AUTHOR(S):\n        0day Inc. <support@0dayinc.com>\n      "
     end
 
-    def self.help
-      puts "USAGE:
-        #{self}.read_gpios(serial_obj: serial_obj, gpio_mask: 0x01)
-        #{self}.write_gpios(serial_obj: serial_obj, gpio_mask: 0x01, gpio_value: 0x01)
-        #{self}.watch_gpios(serial_obj: serial_obj, gpio_mask: 0x01)
+    public_class_method def self.help
+      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

data/lib/meshtastic/rtttl.rb

@@ -4,29 +4,38 @@ require 'meshtastic/rtttl_pb'
 
 module Meshtastic
   module RTTTL
-    def self.encode(opts = {})
+    public_class_method def self.encode(opts = {})
       config = Meshtastic::RTTTLConfig.new
       config.ringtone = opts.fetch(:ringtone, '')
       config
     end
 
-    def self.set(opts = {})
+    public_class_method def self.set(opts = {})
       Admin.send(opts.merge(set_ringtone_message: opts.fetch(:ringtone)))
     end
 
-    def self.get(opts = {})
+    public_class_method def self.get(opts = {})
       Admin.send(opts.merge(get_ringtone_request: true))
     end
 
-    def self.authors
+    public_class_method def self.authors
       "AUTHOR(S):\n        0day Inc. <support@0dayinc.com>\n      "
     end
 
-    def self.help
-      puts "USAGE:
-        #{self}.set(serial_obj: serial_obj, ringtone: 'Mario:d=4,o=5,b=125:16e6')
-        #{self}.get(serial_obj: serial_obj)
+    public_class_method def self.help
+      puts "        USAGE:
+        # Run the encode class method for this module.
+        #{self}.encode
+
+        # Run the set class method for this module.
+        #{self}.set
+
+        # Run the get class method for this module.
+        #{self}.get
+
+        # Run the authors class method for this module.
         #{self}.authors
+
       "
     end
   end

data/lib/meshtastic/serial.rb

@@ -16,11 +16,11 @@ module Meshtastic
   module Serial # rubocop:disable Metrics/ModuleLength
     @last_serial_obj = nil
 
-    module_function
 
     # ---- low-level IO helpers ------------------------------------------------
 
-    def self.clear_hupcl(block_dev)
+    private_class_method def self.clear_hupcl(opts = {})
+      block_dev = opts[:block_dev]
       # Prevent device reboot on open by clearing HUPCL (same as Python pyserial path).
       return unless defined?(Termios)
 
@@ -34,7 +34,6 @@ module Meshtastic
       # Best-effort — uart.open will still work without this.
       nil
     end
-    private_class_method :clear_hupcl
 
     # Supported Method Parameters::
     # proto_thread = init_rx_thread(
@@ -74,7 +73,7 @@ module Meshtastic
               # looking for START1
               unless c == Meshtastic::START1
                 rx_buf = empty.dup
-                append_console_byte(chunk, debug_out, serial_obj)
+                append_console_byte(chunk: chunk, debug_out: debug_out, serial_obj: serial_obj)
               end
             elsif ptr == 1
               # looking for START2
@@ -110,7 +109,10 @@ module Meshtastic
     end
 
 
-    private_class_method def self.append_console_byte(chunk, debug_out, serial_obj)
+    private_class_method def self.append_console_byte(opts = {})
+      chunk = opts[:chunk]
+      debug_out = opts[:debug_out]
+      serial_obj = opts[:serial_obj]
       if debug_out
         begin
           debug_out.write(chunk.force_encoding('UTF-8'))
@@ -259,7 +261,7 @@ module Meshtastic
 
       mode = "#{data_bits}#{parity_char}#{stop_bits}"
 
-      clear_hupcl(block_dev)
+      clear_hupcl(block_dev: block_dev)
 
       serial_conn = UART.open(block_dev, baud, mode)
 
@@ -329,7 +331,7 @@ module Meshtastic
     # stdout_data = Meshtastic::Serial.dump_stdout_data(
     #   type: 'required - :proto or :console'
     # )
-    public_class_method def self.dump_stdout_data(opts = {}, &)
+    public_class_method def self.dump_stdout_data(opts = {})
       type = opts[:type]
       valid_types = %i[proto console]
       raise "ERROR: Invalid type: #{type}. Supported types are :proto or :console" unless valid_types.include?(type)
@@ -342,7 +344,7 @@ module Meshtastic
       end
       return data unless block_given?
 
-      (type == :proto ? data : data.split("\n")).each(&)
+      (type == :proto ? data : data.split("\n")).each { |row| yield row } # rubocop:disable Style/ExplicitBlockArgument
       nil
     end
 
@@ -705,100 +707,109 @@ module Meshtastic
     # Display Usage for this Module
 
     public_class_method def self.help
-      puts "Send and receive Meshtastic messages over a framed serial (USB/UART) connection.
-
-      USAGE:
-        serial_obj = #{self}.connect(
-          block_dev: 'optional - serial block device path (defaults to /dev/ttyUSB0)',
-          baud: 'optional - (defaults to 115200)',
-          data_bits: 'optional - (defaults to 8)',
-          stop_bits: 'optional - (defaults to 1)',
-          parity: 'optional - :even|:odd|:none (defaults to :none)',
-          debug_out: 'optional - IO receiving non-protobuf debug console bytes',
-          want_config: 'optional - request full node DB after connect (default: true)'
+      puts "        USAGE:
+        # Run the request class method for this module.
+        #{self}.request(
+          serial_obj: 'optional - value for serial_obj passed into request',
+          payload: 'optional - value for payload passed into request'
         )
 
-        #{self}.wait_for_config(
-          serial_obj: 'required - serial_obj connected with want_config: true',
-          timeout: 'optional - seconds to await configuration (default: 10; raises Timeout::Error)'
+        # Run the send_to_radio class method for this module.
+        #{self}.send_to_radio(
+          serial_obj: 'optional - value for serial_obj passed into send_to_radio',
+          to_radio: 'optional - value for to_radio passed into send_to_radio'
         )
 
-        #{self}.wake_up_device(
-          serial_obj: 'required - serial_obj returned from #connect method'
+        # Run the connect class method for this module.
+        #{self}.connect(
+          block_dev: 'optional - value for block_dev passed into connect',
+          baud: 'optional - value for baud passed into connect',
+          data_bits: 'optional - value for data_bits passed into connect',
+          stop_bits: 'optional - value for stop_bits passed into connect',
+          parity: 'optional - value for parity passed into connect',
+          debug_out: 'optional - value for debug_out passed into connect'
         )
 
-        #{self}.request(
-          serial_obj: 'required serial_obj returned from #connect method',
-          payload: 'required - array of bytes OR string to write to serial device'
+        # Run the wait_for_config class method for this module.
+        #{self}.wait_for_config(
+          serial_obj: 'optional - value for serial_obj passed into wait_for_config'
         )
 
-        #{self}.send_to_radio(
-          serial_obj: 'required - serial_obj returned from #connect method',
-          to_radio: 'required - Meshtastic::ToRadio OR serialized String'
+        # Run the wake_up_device class method for this module.
+        #{self}.wake_up_device(
+          serial_obj: 'optional - value for serial_obj passed into wake_up_device'
         )
 
-        from_radio = #{self}.recv_from_radio(
-          serial_obj: 'optional - serial_obj (default: most recently opened connection)',
-          timeout: 'optional - seconds (default: 5; 0 = poll; nil = block forever)'
+        # Run the dump_stdout_data class method for this module.
+        #{self}.dump_stdout_data(
+          type: 'optional - value for type passed into dump_stdout_data',
+          serial_obj: 'optional - value for serial_obj passed into dump_stdout_data'
         )
 
-        msgs = #{self}.drain_from_radio(serial_obj: serial_obj, max: 256)
+        # Run the flush_data class method for this module.
+        #{self}.flush_data(
+          type: 'optional - value for type passed into flush_data',
+          serial_obj: 'optional - value for serial_obj passed into flush_data'
+        )
 
-        stdout_data = #{self}.dump_stdout_data(
-          serial_obj: 'optional - serial_obj (default: most recently opened connection)',
-          type: 'required - :proto or :console'
+        # Run the drain_from_radio class method for this module.
+        #{self}.drain_from_radio(
+          max: 'optional - value for max passed into drain_from_radio',
+          serial_obj: 'optional - value for serial_obj passed into drain_from_radio'
         )
 
-        #{self}.flush_data(
-          serial_obj: 'optional - serial_obj (default: most recently opened connection)',
-          type: 'required - :console or :proto'
+        # Run the recv_from_radio class method for this module.
+        #{self}.recv_from_radio(
+          serial_obj: 'optional - value for serial_obj passed into recv_from_radio'
         )
 
+        # Run the monitor_stdout class method for this module.
         #{self}.monitor_stdout(
-          serial_obj: 'required - serial_obj returned from #connect method',
-          type: 'required - :proto or :console',
-          refresh: 'optional - refresh interval (default: 3)',
-          include: 'optional - comma-delimited string(s) to include in message',
-          exclude: 'optional - comma-delimited string(s) to exclude in message'
+          serial_obj: 'optional - value for serial_obj passed into monitor_stdout',
+          type: 'optional - value for type passed into monitor_stdout',
+          refresh: 'optional - value for refresh passed into monitor_stdout',
+          include: 'optional - value for include passed into monitor_stdout',
+          exclude: 'optional - value for exclude passed into monitor_stdout'
         )
 
+        # Run the subscribe class method for this module.
         #{self}.subscribe(
-          serial_obj: 'required - serial_obj returned from #connect method',
-          psks: 'optional - hash of :channel_id => psk (default: { LongFast: \"AQ==\" })',
-          exclude: 'optional - comma-delimited string(s) to exclude',
-          include: 'optional - comma-delimited string(s) to include',
-          gps_metadata: 'optional - include GPS metadata (default: false)',
-          include_raw: 'optional - include raw packet bytes (default: false)',
-          timeout: 'optional - seconds per pop (default: nil = forever)'
+          serial_obj: 'optional - value for serial_obj passed into subscribe',
+          psks: 'optional - value for psks 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',
+          timeout: 'optional - value for timeout passed into subscribe'
         )
 
+        # Run the send_text class method for this module.
         #{self}.send_text(
-          serial_obj: 'required - serial_obj returned from #connect method',
-          from: 'optional - From ID (Default: local my_node_num or 0 for firmware-assigned)',
-          to: 'optional - Destination ID (Default: \"!ffffffff\")',
-          channel: 'optional - channel index (Default: 0)',
-          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)'
+          serial_obj: 'optional - value for serial_obj passed into send_text',
+          via: 'optional - value for via passed into send_text',
+          channel: 'optional - value for channel passed into send_text',
+          from: 'optional - value for from passed into send_text',
+          psks: 'optional - value for psks 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(
-          serial_obj: 'required - serial_obj returned from #connect method',
-          from: 'optional - From ID',
-          to: 'optional - Destination ID (Default: \"!ffffffff\")',
-          channel: 'optional - channel index (Default: 0)',
-          data: 'required - Meshtastic::Data',
-          want_ack: 'optional - Want Acknowledgement (Default: false)',
-          hop_limit: 'optional - Hop Limit (Default: 3)',
-          port_num: 'optional - PortNum (Default: PRIVATE_APP)'
+          serial_obj: 'optional - value for serial_obj passed into send_data',
+          via: 'optional - value for via passed into send_data',
+          channel: 'optional - value for channel passed into send_data',
+          psks: 'optional - value for psks passed into send_data',
+          from: 'optional - value for from passed into send_data'
         )
 
-        serial_obj = #{self}.disconnect(
-          serial_obj: 'required - serial_obj returned from #connect method'
+        # Run the disconnect class method for this module.
+        #{self}.disconnect(
+          serial_obj: 'optional - value for serial_obj passed into disconnect'
         )
 
+        # Run the authors class method for this module.
         #{self}.authors
+
       "
     end
   end

data/lib/meshtastic/storeforward.rb

@@ -4,13 +4,13 @@ require 'meshtastic/storeforward_pb'
 
 module Meshtastic
   module Storeforward
-    def self.encode(opts = {})
+    public_class_method def self.encode(opts = {})
       message = Meshtastic::StoreAndForward.new
       message.rr = opts.fetch(:rr, :ROUTER_HEARTBEAT)
       message
     end
 
-    def self.send(opts = {})
+    public_class_method def self.send(opts = {})
       data = Meshtastic::Data.new(
         portnum: :STORE_FORWARD_APP,
         payload: encode(opts).to_proto
@@ -18,14 +18,21 @@ module Meshtastic
       Meshtastic.deliver_data(opts.merge(data: data, port_num: Meshtastic::PortNum::STORE_FORWARD_APP))
     end
 
-    def self.authors
+    public_class_method def self.authors
       "AUTHOR(S):\n        0day Inc. <support@0dayinc.com>\n      "
     end
 
-    def self.help
-      puts "USAGE:
-        #{self}.send(serial_obj: serial_obj, rr: :CLIENT_HISTORY)
+    public_class_method def self.help
+      puts "        USAGE:
+        # Run the encode class method for this module.
+        #{self}.encode
+
+        # Run the send class method for this module.
+        #{self}.send
+
+        # Run the authors class method for this module.
         #{self}.authors
+
       "
     end
   end

data/lib/meshtastic/storeforward_pb.rb

@@ -5,7 +5,7 @@
 require 'google/protobuf'
 
 
-descriptor_data = "\n\x1dmeshtastic/storeforward.proto\x12\nmeshtastic\"\x9c\x07\n\x0fStoreAndForward\x12\x37\n\x02rr\x18\x01 \x01(\x0e\x32+.meshtastic.StoreAndForward.RequestResponse\x12\x37\n\x05stats\x18\x02 \x01(\x0b\x32&.meshtastic.StoreAndForward.StatisticsH\x00\x12\x36\n\x07history\x18\x03 \x01(\x0b\x32#.meshtastic.StoreAndForward.HistoryH\x00\x12:\n\theartbeat\x18\x04 \x01(\x0b\x32%.meshtastic.StoreAndForward.HeartbeatH\x00\x12\x0e\n\x04text\x18\x05 \x01(\x0cH\x00\x1a\xcd\x01\n\nStatistics\x12\x16\n\x0emessages_total\x18\x01 \x01(\r\x12\x16\n\x0emessages_saved\x18\x02 \x01(\r\x12\x14\n\x0cmessages_max\x18\x03 \x01(\r\x12\x0f\n\x07up_time\x18\x04 \x01(\r\x12\x10\n\x08requests\x18\x05 \x01(\r\x12\x18\n\x10requests_history\x18\x06 \x01(\r\x12\x11\n\theartbeat\x18\x07 \x01(\x08\x12\x12\n\nreturn_max\x18\x08 \x01(\r\x12\x15\n\rreturn_window\x18\t \x01(\r\x1aI\n\x07History\x12\x18\n\x10history_messages\x18\x01 \x01(\r\x12\x0e\n\x06window\x18\x02 \x01(\r\x12\x14\n\x0clast_request\x18\x03 \x01(\r\x1a.\n\tHeartbeat\x12\x0e\n\x06period\x18\x01 \x01(\r\x12\x11\n\tsecondary\x18\x02 \x01(\r\"\xbc\x02\n\x0fRequestResponse\x12\t\n\x05UNSET\x10\x00\x12\x10\n\x0cROUTER_ERROR\x10\x01\x12\x14\n\x10ROUTER_HEARTBEAT\x10\x02\x12\x0f\n\x0bROUTER_PING\x10\x03\x12\x0f\n\x0bROUTER_PONG\x10\x04\x12\x0f\n\x0bROUTER_BUSY\x10\x05\x12\x12\n\x0eROUTER_HISTORY\x10\x06\x12\x10\n\x0cROUTER_STATS\x10\x07\x12\x16\n\x12ROUTER_TEXT_DIRECT\x10\x08\x12\x19\n\x15ROUTER_TEXT_BROADCAST\x10\t\x12\x10\n\x0c\x43LIENT_ERROR\x10@\x12\x12\n\x0e\x43LIENT_HISTORY\x10\x41\x12\x10\n\x0c\x43LIENT_STATS\x10\x42\x12\x0f\n\x0b\x43LIENT_PING\x10\x43\x12\x0f\n\x0b\x43LIENT_PONG\x10\x44\x12\x10\n\x0c\x43LIENT_ABORT\x10jB\t\n\x07variantBk\n\x14org.meshtastic.protoB\x15StoreAndForwardProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3"
+descriptor_data = "\n\x1dmeshtastic/storeforward.proto\x12\nmeshtastic\"\xb1\x07\n\x0fStoreAndForward\x12\x37\n\x02rr\x18\x01 \x01(\x0e\x32+.meshtastic.StoreAndForward.RequestResponse\x12\x37\n\x05stats\x18\x02 \x01(\x0b\x32&.meshtastic.StoreAndForward.StatisticsH\x00\x12\x36\n\x07history\x18\x03 \x01(\x0b\x32#.meshtastic.StoreAndForward.HistoryH\x00\x12:\n\theartbeat\x18\x04 \x01(\x0b\x32%.meshtastic.StoreAndForward.HeartbeatH\x00\x12\x0e\n\x04text\x18\x05 \x01(\x0cH\x00\x12\x13\n\x0boriginal_id\x18\x06 \x01(\r\x1a\xcd\x01\n\nStatistics\x12\x16\n\x0emessages_total\x18\x01 \x01(\r\x12\x16\n\x0emessages_saved\x18\x02 \x01(\r\x12\x14\n\x0cmessages_max\x18\x03 \x01(\r\x12\x0f\n\x07up_time\x18\x04 \x01(\r\x12\x10\n\x08requests\x18\x05 \x01(\r\x12\x18\n\x10requests_history\x18\x06 \x01(\r\x12\x11\n\theartbeat\x18\x07 \x01(\x08\x12\x12\n\nreturn_max\x18\x08 \x01(\r\x12\x15\n\rreturn_window\x18\t \x01(\r\x1aI\n\x07History\x12\x18\n\x10history_messages\x18\x01 \x01(\r\x12\x0e\n\x06window\x18\x02 \x01(\r\x12\x14\n\x0clast_request\x18\x03 \x01(\r\x1a.\n\tHeartbeat\x12\x0e\n\x06period\x18\x01 \x01(\r\x12\x11\n\tsecondary\x18\x02 \x01(\r\"\xbc\x02\n\x0fRequestResponse\x12\t\n\x05UNSET\x10\x00\x12\x10\n\x0cROUTER_ERROR\x10\x01\x12\x14\n\x10ROUTER_HEARTBEAT\x10\x02\x12\x0f\n\x0bROUTER_PING\x10\x03\x12\x0f\n\x0bROUTER_PONG\x10\x04\x12\x0f\n\x0bROUTER_BUSY\x10\x05\x12\x12\n\x0eROUTER_HISTORY\x10\x06\x12\x10\n\x0cROUTER_STATS\x10\x07\x12\x16\n\x12ROUTER_TEXT_DIRECT\x10\x08\x12\x19\n\x15ROUTER_TEXT_BROADCAST\x10\t\x12\x10\n\x0c\x43LIENT_ERROR\x10@\x12\x12\n\x0e\x43LIENT_HISTORY\x10\x41\x12\x10\n\x0c\x43LIENT_STATS\x10\x42\x12\x0f\n\x0b\x43LIENT_PING\x10\x43\x12\x0f\n\x0b\x43LIENT_PONG\x10\x44\x12\x10\n\x0c\x43LIENT_ABORT\x10jB\t\n\x07variantBk\n\x14org.meshtastic.protoB\x15StoreAndForwardProtosZ\"github.com/meshtastic/go/generated\xaa\x02\x14Meshtastic.Protobufs\xba\x02\x00\x62\x06proto3"
 
 pool = ::Google::Protobuf::DescriptorPool.generated_pool
 pool.add_serialized_file(descriptor_data)

data/lib/meshtastic/stream_interface.rb

@@ -128,5 +128,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/tcp.rb

@@ -8,7 +8,7 @@ module Meshtastic
   module TCP
     DEFAULT_PORT = 4403
 
-    def self.connect(opts = {})
+    public_class_method def self.connect(opts = {})
       host = opts[:host] ||= '127.0.0.1'
       port = opts[:port] ||= DEFAULT_PORT
       tcp_obj = nil
@@ -45,57 +45,108 @@ module Meshtastic
       raise
     end
 
-    def self.wait_for_config(opts = {})
+    public_class_method def self.wait_for_config(opts = {})
       Meshtastic::Serial.wait_for_config(opts.merge(serial_obj: opts[:tcp_obj] || opts[:serial_obj]))
     end
 
-    def self.send_to_radio(opts = {})
+    public_class_method def self.send_to_radio(opts = {})
       Meshtastic::Serial.send_to_radio(opts.merge(serial_obj: opts[:tcp_obj] || opts[:serial_obj]))
     end
 
-    def self.send_text(opts = {})
+    public_class_method def self.send_text(opts = {})
       Meshtastic::Serial.send_text(opts.merge(serial_obj: opts[:tcp_obj] || opts[:serial_obj]))
     end
 
-    def self.send_data(opts = {})
+    public_class_method def self.send_data(opts = {})
       Meshtastic::Serial.send_data(opts.merge(serial_obj: opts[:tcp_obj] || opts[:serial_obj]))
     end
 
-    def self.recv_from_radio(opts = {})
+    public_class_method def self.recv_from_radio(opts = {})
       Meshtastic::Serial.recv_from_radio(opts.merge(serial_obj: opts[:tcp_obj] || opts[:serial_obj]))
     end
 
-    def self.drain_from_radio(opts = {})
+    public_class_method def self.drain_from_radio(opts = {})
       Meshtastic::Serial.drain_from_radio(opts.merge(serial_obj: opts[:tcp_obj] || opts[:serial_obj]))
     end
 
-    def self.subscribe(opts = {}, &)
-      Meshtastic::Serial.subscribe(opts.merge(serial_obj: opts[:tcp_obj] || opts[:serial_obj]), &)
+    public_class_method def self.subscribe(opts = {})
+      merged = opts.merge(serial_obj: opts[:tcp_obj] || opts[:serial_obj])
+      if block_given?
+        Meshtastic::Serial.subscribe(merged) { |msg| yield msg } # rubocop:disable Style/ExplicitBlockArgument
+      else
+        Meshtastic::Serial.subscribe(merged)
+      end
     end
 
-    def self.disconnect(opts = {})
+    public_class_method def self.disconnect(opts = {})
       Meshtastic::Serial.disconnect(serial_obj: opts[:tcp_obj] || opts[:serial_obj])
     end
 
-    def self.authors
+    public_class_method def self.authors
       "AUTHOR(S):\n        0day Inc. <support@0dayinc.com>\n      "
     end
 
-    def self.help
-      puts "Send and receive Meshtastic messages over TCP (default port #{DEFAULT_PORT}).
+    public_class_method def self.help
+      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',
+          socket: 'optional - value for socket passed into connect',
+          debug_out: 'optional - value for debug_out passed into connect'
+        )
 
-      USAGE:
-        tcp_obj = #{self}.connect(
-          host: 'optional - (default: 127.0.0.1)',
-          port: 'optional - (default: 4403)',
-          want_config: 'optional - request full node DB after connect (default: true)'
+        # Run the wait_for_config class method for this module.
+        #{self}.wait_for_config(
+          tcp_obj: 'optional - value for tcp_obj passed into wait_for_config',
+          serial_obj: 'optional - value for serial_obj passed into wait_for_config'
         )
 
-        #{self}.wait_for_config(tcp_obj: tcp_obj, timeout: 10)
-        #{self}.send_text(tcp_obj: tcp_obj, to: '!ffffffff', channel: 0, text: 'Hello over TCP!')
-        #{self}.subscribe(tcp_obj: tcp_obj, include: 'TEXT_MESSAGE_APP')
-        #{self}.disconnect(tcp_obj: tcp_obj)
+        # Run the send_to_radio class method for this module.
+        #{self}.send_to_radio(
+          tcp_obj: 'optional - value for tcp_obj passed into send_to_radio',
+          serial_obj: 'optional - value for serial_obj passed into send_to_radio'
+        )
+
+        # Run the send_text class method for this module.
+        #{self}.send_text(
+          tcp_obj: 'optional - value for tcp_obj passed into send_text',
+          serial_obj: 'optional - value for serial_obj passed into send_text'
+        )
+
+        # Run the send_data class method for this module.
+        #{self}.send_data(
+          tcp_obj: 'optional - value for tcp_obj passed into send_data',
+          serial_obj: 'optional - value for serial_obj passed into send_data'
+        )
+
+        # Run the recv_from_radio class method for this module.
+        #{self}.recv_from_radio(
+          tcp_obj: 'optional - value for tcp_obj passed into recv_from_radio',
+          serial_obj: 'optional - value for serial_obj passed into recv_from_radio'
+        )
+
+        # Run the drain_from_radio class method for this module.
+        #{self}.drain_from_radio(
+          tcp_obj: 'optional - value for tcp_obj passed into drain_from_radio',
+          serial_obj: 'optional - value for serial_obj passed into drain_from_radio'
+        )
+
+        # Run the subscribe class method for this module.
+        #{self}.subscribe(
+          tcp_obj: 'optional - value for tcp_obj passed into subscribe',
+          serial_obj: 'optional - value for serial_obj passed into subscribe'
+        )
+
+        # Run the disconnect class method for this module.
+        #{self}.disconnect(
+          tcp_obj: 'optional - value for tcp_obj passed into disconnect',
+          serial_obj: 'optional - value for serial_obj passed into disconnect'
+        )
+
+        # Run the authors class method for this module.
         #{self}.authors
+
       "
     end
   end