pwn 0.5.708 → 0.5.709

data/lib/pwn/sdr/decoder/pocsag.rb

@@ -220,21 +220,41 @@ module PWN
         # Display Usage for this Module
 
         public_class_method def self.help
-          puts "USAGE (true-air I/Q + GQRX-audio native paths, no external binaries):
-            #{self}.decode(
-              freq_obj: 'required - freq_obj returned from PWN::SDR::GQRX.init_freq'
+          puts "USAGE:
+            # Run decode bits and return its result
+            #{self}.decode_bits(
+              bits: 'optional - bits value consumed by #decode_bits (defaults to [])',
+              baud: 'optional - baud value consumed by #decode_bits'
+            )
+
+            # Run assemble and return its result
+            #{self}.assemble(
+              pending: 'optional - pending value consumed by #assemble',
+              baud: 'optional - baud value consumed by #assemble'
+            )
+
+            # Run numeric decode and return its result
+            #{self}.numeric_decode(
+              words: 'optional - words value consumed by #numeric_decode (defaults to [])'
             )
 
-            #{self}.decode_bits(bits: [0,1,...], baud: 1200) { |msg| ... }
-            #{self}.assemble(pending: {ric:, func:, msg_words:[]}, baud: 1200)
-            #{self}.numeric_decode(words: [Integer, ...])
-            #{self}.alpha_decode(words: [Integer, ...])
+            # Run alpha decode and return its result
+            #{self}.alpha_decode(
+              words: 'optional - words value consumed by #alpha_decode (defaults to [])'
+            )
 
-            NOTE: Set GQRX to Narrow FM. Baud (512/1200/2400) and NRZ
-                  polarity are auto-detected from the FSC 0x7CD215D8.
+            # Run decode and return its result
+            #{self}.decode(
+              freq_obj: 'required - freq_obj returned from PWN::SDR::GQRX.init_freq',
+              source: 'optional - source value consumed by #decode',
+              file: 'optional - filesystem path',
+              sample_rate: 'optional - sample rate value consumed by #decode'
+            )
 
+            # Print the AUTHOR(S) string for this module.
             #{self}.authors
           "
+          constants.sort
         end
       end
     end

data/lib/pwn/sdr/decoder/rds.rb

@@ -194,21 +194,27 @@ module PWN
 
         public_class_method def self.help
           puts "USAGE:
-            # Non-interactive (agents / automation) — returns a Hash:
-            rds = #{self}.sample(
-              gqrx_sock: sock,          # or freq_obj: from init_freq
-              settle_secs: 8,           # default 8, max 30
-              leave_enabled: false
+            # Run sample and return its result
+            #{self}.sample(
+              gqrx_sock: 'required - required unless freq_obj - TCPSocket from GQRX.connect',
+              freq_obj: 'required - required unless gqrx_sock - Hash from GQRX.init_freq',
+              settle_secs: 'optional - seconds to sample (default 8, max 30)',
+              interval: 'optional - poll interval seconds (default 0.75)',
+              leave_enabled: 'optional - leave RDS decoder ON after sample (default false)',
+              pi: 'required - ps_name:, radiotext:, station:',
+              samples: 'required - Integer, settle_secs: Float',
+              error: 'required - String?   # present when RDS backend is unavailable'
             )
-            # => { pi:, ps_name:, radiotext:, station:, samples:, settle_secs: }
 
-            # Interactive TTY spinner (human REPL via GQRX.init_freq decoder: :rds):
+            # Interactive TTY UX: enables RDS, spins a live status line until the
             #{self}.decode(
-              freq_obj: 'required - freq_obj returned from PWN::SDR::GQRX.init_freq method'
+              freq_obj: 'required - Hash returned from PWN::SDR::GQRX.init_freq'
             )
 
+            # Print the AUTHOR(S) string for this module.
             #{self}.authors
           "
+          constants.sort
         end
 
         # ---- internals -------------------------------------------------------

data/lib/pwn/sdr/decoder/rfid.rb

@@ -117,15 +117,24 @@ module PWN
         end
 
         public_class_method def self.help
-          puts "USAGE (true-air I/Q via PWN::FFI + detector fallback):
+          puts "USAGE:
+            # Run decode and return its result
             #{self}.decode(
               freq_obj: 'required - freq_obj returned from PWN::SDR::GQRX.init_freq',
-              source:   'optional - :auto|:rtlsdr|:adalm_pluto|:file',
-              file:     'optional - .cu8/.cs16 capture'
+              sample_rate: 'optional - sample rate value consumed by #decode',
+              source: 'optional - source value consumed by #decode',
+              file: 'optional - filesystem path'
             )
 
+            # Run parse line and return its result
+            #{self}.parse_line(
+              line: 'optional - line value consumed by #parse_line'
+            )
+
+            # Print the AUTHOR(S) string for this module.
             #{self}.authors
           "
+          constants.sort
         end
       end
     end

data/lib/pwn/sdr/decoder/rtl433.rb

@@ -128,15 +128,24 @@ module PWN
         end
 
         public_class_method def self.help
-          puts "USAGE (true-air I/Q via PWN::FFI + detector fallback):
+          puts "USAGE:
+            # Run decode and return its result
             #{self}.decode(
               freq_obj: 'required - freq_obj returned from PWN::SDR::GQRX.init_freq',
-              source:   'optional - :auto|:rtlsdr|:adalm_pluto|:file',
-              file:     'optional - .cu8/.cs16 capture'
+              sample_rate: 'optional - sample rate value consumed by #decode',
+              source: 'optional - source value consumed by #decode',
+              file: 'optional - filesystem path'
             )
 
+            # Run parse line and return its result
+            #{self}.parse_line(
+              line: 'optional - line value consumed by #parse_line'
+            )
+
+            # Print the AUTHOR(S) string for this module.
             #{self}.authors
           "
+          constants.sort
         end
       end
     end

data/lib/pwn/sdr/decoder/rtty.rb

@@ -139,16 +139,19 @@ module PWN
         # Display Usage for this Module
 
         public_class_method def self.help
-          puts "USAGE (true-air I/Q + GQRX-audio native paths, no external binaries):
+          puts "USAGE:
+            # Run decode and return its result
             #{self}.decode(
-              freq_obj: 'required - freq_obj returned from PWN::SDR::GQRX.init_freq'
+              freq_obj: 'required - freq_obj returned from PWN::SDR::GQRX.init_freq',
+              source: 'optional - source value consumed by #decode',
+              file: 'optional - filesystem path',
+              sample_rate: 'optional - sample rate value consumed by #decode'
             )
 
-            NOTE: Set GQRX to USB, tune so mark≈2125 Hz / space≈2295 Hz in
-                  the audio passband. 45.45 baud, 170 Hz shift, 1N5+1.5.
-
+            # Print the AUTHOR(S) string for this module.
             #{self}.authors
           "
+          constants.sort
         end
       end
     end

data/lib/pwn/sdr/decoder/wifi.rb

@@ -115,15 +115,24 @@ module PWN
         end
 
         public_class_method def self.help
-          puts "USAGE (true-air I/Q via PWN::FFI + detector fallback):
+          puts "USAGE:
+            # Run decode and return its result
             #{self}.decode(
               freq_obj: 'required - freq_obj returned from PWN::SDR::GQRX.init_freq',
-              source:   'optional - :auto|:rtlsdr|:adalm_pluto|:file',
-              file:     'optional - .cu8/.cs16 capture'
+              sample_rate: 'optional - sample rate value consumed by #decode',
+              source: 'optional - source value consumed by #decode',
+              file: 'optional - filesystem path'
             )
 
+            # Run parse line and return its result
+            #{self}.parse_line(
+              line: 'optional - line value consumed by #parse_line'
+            )
+
+            # Print the AUTHOR(S) string for this module.
             #{self}.authors
           "
+          constants.sort
         end
       end
     end

data/lib/pwn/sdr/decoder/zigbee.rb

@@ -184,15 +184,24 @@ module PWN
         end
 
         public_class_method def self.help
-          puts "USAGE (true-air I/Q via PWN::FFI + detector fallback):
+          puts "USAGE:
+            # Run decode and return its result
             #{self}.decode(
               freq_obj: 'required - freq_obj returned from PWN::SDR::GQRX.init_freq',
-              source:   'optional - :auto|:rtlsdr|:adalm_pluto|:file',
-              file:     'optional - .cu8/.cs16 capture (≥4 Msps)'
+              sample_rate: 'optional - sample rate value consumed by #decode',
+              source: 'optional - source value consumed by #decode',
+              file: 'optional - filesystem path'
             )
 
+            # Run parse line and return its result
+            #{self}.parse_line(
+              line: 'optional - line value consumed by #parse_line'
+            )
+
+            # Print the AUTHOR(S) string for this module.
             #{self}.authors
           "
+          constants.sort
         end
       end
     end

data/lib/pwn/sdr/decoder.rb

@@ -91,6 +91,15 @@ module PWN
       # Display a List of Every PWN::SDR::Decoder Module
 
       public_class_method def self.help
+        puts "USAGE:
+          # Run resolve and return its result
+          #{self}.resolve(
+            decoder: 'required - Symbol/String key from REGISTRY (e.g. :pocsag)'
+          )
+
+          # Print the AUTHOR(S) string for this module.
+          #{self}.authors
+        "
         constants.sort
       end
     end

data/lib/pwn/sdr/flipper_zero.rb

@@ -99,29 +99,36 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
+          # Run connect via screen and return its result
           #{self}.connect_via_screen(
-            block_dev: 'optional serial block device path (defaults to /dev/ttyUSB0)'
+            block_dev: 'optional - serial block device path (defaults to /dev/ttyACM0)'
           )
 
-          flipper_zero_obj = #{self}.connect(
-            block_dev: 'optional serial block device path (defaults to /dev/ttyUSB0)',
-            baud: 'optional (defaults to 9600)',
-            data_bits: 'optional (defaults to 8)',
-            stop_bits: 'optional (defaults to 1)',
-            parity: 'optional - :even||:odd|:none (defaults to :none)'
+          # Run connect and return its result
+          #{self}.connect(
+            block_dev: 'optional - optional serial block device path (defaults to /dev/ttyACM0)',
+            baud: 'optional - optional (defaults to 9600)',
+            data_bits: 'optional - optional (defaults to 8)',
+            stop_bits: 'optional - optional (defaults to 1)',
+            parity: 'optional - :even||:odd|:none (defaults to :none)',
+            flipper_zero_obj: 'optional - flipper zero obj value consumed by #connect'
           )
 
-          response = #{self}.request(
+          # Run request and return its result
+          #{self}.request(
             flipper_zero_obj: 'required - flipper_zero_obj returned from #connect method',
-            payload: 'required - payload to send to the device'
-          );
+            payload: 'optional - payload to send to the device (defaults to help)'
+          )
 
+          # Run disconnect and return its result
           #{self}.disconnect(
             flipper_zero_obj: 'required - flipper_zero_obj returned from #connect method'
           )
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end

data/lib/pwn/sdr/frequency_allocation.rb

@@ -822,10 +822,13 @@ module PWN
 
       public_class_method def self.help
         puts "USAGE:
-          band_plans = #{self}.band_plans
+          # Run band plans and return its result
+          #{self}.band_plans
 
+          # Print the AUTHOR(S) string for this module.
           #{self}.authors
         "
+        constants.sort
       end
     end
   end