peak 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: df65f4faa4d3b4e36b51a9d6b4a5bba37bb2c992
-  data.tar.gz: 9b35a626888fe27afe140abe5dc0bef82d154ae7
+SHA256:
+  metadata.gz: 2be0cb7af674767f2a268f5427409539eec1624a57f5ed8f0dfeef69c99792fd
+  data.tar.gz: cc79220db1b7bf56ea98d220c42b6f29b5862ae05087bc1851429c68f74951a5
 SHA512:
-  metadata.gz: 712d1e69d00909111a9bca843918276148103c3372b69f1b08ec61176195edbd31f936c12eef7f7960b5f73a3730094f1937431215fc4f0ae38a34ecbb9c2b4d
-  data.tar.gz: 8f3a5a14d1a7d28b2e16d1d6bde9df2d2a11b5a01d988d7ed0dcdf445fd56fd143a7d22aeb83cc34c615d2c28de7e9aac5f4c77a73359f6e1ae679b82181c7a0
+  metadata.gz: eb85c260e4bee7519cc6909eea953fbfcd108f93eaf702559ada7a907a45463428dc3bd34e1ad5217aa13857890c326cdc767407ddf15f504661164550d75e7d
+  data.tar.gz: e6461ea24e69edc1922cf11f9c0b1b66f14281b7cd3d218dc50030188fb09c057ca4d4ce733578618948c65802223be7e7a67e12091ec95e32921ea4d78e78cf

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.0.3
+
+* Fixed a bug where crossband digipeating would send the packet out on the same TNC rather than the intended TNC.
+* Added configurable packet echoing to determine which packets get echoed onto the screen.
+* Updated all depdendencies to their latest.
+
 ## 1.0.2
 
 * Added proper cleanup before exiting when a sigterm or sigint is received. This allows serial connections to be
@@ -16,4 +22,4 @@
 
 ## 1.0.0
 
-* Initial release
+* Initial release

data/CONTRIBUTORS.md

@@ -1,4 +1,5 @@
 * Jeffrey Phillips Freeman (WI2ARD) - http://JeffreyFreeman.me
+* Greg Albrecht W2GMD <oss@undef.net>
 * Martin Murray (KD8LVZ)
 * Paul McMillan - https://github.com/PaulMcMillan
 * Russ Innes

data/README.rdoc

@@ -7,7 +7,7 @@ Author::  Jeffrey Phillips Freeman, WI2ARD (freemo@gmail.com)
 Copyright:: Copyright (c) 2016 - present Syncleus, Inc.
 
 Peak is a full suite APRS client and reference implementation for the APEX protocol. APEX is a next generation APRS
-based protocol. This repository represents the official application implementing APEX. It is a full-feature application
+based protocol. It is a full-feature application
 for digipeating, compatible with most AX.25 KISS TNC devices, and utilizing the full APEX stack.
 
 For more information on the project please check out {the project's home page}[http://apexprotocol.com/].
@@ -42,6 +42,147 @@ To install this gem onto your local machine, run <code>bundle exec rake install<
 version number in +app_info.rb+, and then run <code>bundle exec rake release</code>, which will create a git tag for the version,
 push git commits and tags, and push the +.gem+ file to {rubygems.org}[https://rubygems.org].
 
+== Consistent ports
+
+It is important that the ports associated with the TNCs be consistent between boots. To do this first get the info using `lsusb -v`,
+for example you might get the following:
+
+```
+Bus 001 Device 005: ID 0403:d011 Future Technology Devices International, Ltd SCS Position-Tracker/TNC
+Couldn't open device, some information will be missing
+Device Descriptor:
+  bLength                18
+  bDescriptorType         1
+  bcdUSB               2.00
+  bDeviceClass            0 
+  bDeviceSubClass         0 
+  bDeviceProtocol         0 
+  bMaxPacketSize0         8
+  idVendor           0x0403 Future Technology Devices International, Ltd
+  idProduct          0xd011 SCS Position-Tracker/TNC
+  bcdDevice            6.00
+  iManufacturer           1 SCS
+  iProduct                2 SCS Tracker / DSP TNC
+  iSerial                 3 PT5690Y
+  bNumConfigurations      1
+  Configuration Descriptor:
+    bLength                 9
+    bDescriptorType         2
+    wTotalLength       0x0020
+    bNumInterfaces          1
+    bConfigurationValue     1
+    iConfiguration          0 
+    bmAttributes         0xc0
+      Self Powered
+    MaxPower                0mA
+    Interface Descriptor:
+      bLength                 9
+      bDescriptorType         4
+      bInterfaceNumber        0
+      bAlternateSetting       0
+      bNumEndpoints           2
+      bInterfaceClass       255 Vendor Specific Class
+      bInterfaceSubClass    255 Vendor Specific Subclass
+      bInterfaceProtocol    255 Vendor Specific Protocol
+      iInterface              2 
+      Endpoint Descriptor:
+        bLength                 7
+        bDescriptorType         5
+        bEndpointAddress     0x81  EP 1 IN
+        bmAttributes            2
+          Transfer Type            Bulk
+          Synch Type               None
+          Usage Type               Data
+        wMaxPacketSize     0x0040  1x 64 bytes
+        bInterval               0
+      Endpoint Descriptor:
+        bLength                 7
+        bDescriptorType         5
+        bEndpointAddress     0x02  EP 2 OUT
+        bmAttributes            2
+          Transfer Type            Bulk
+          Synch Type               None
+          Usage Type               Data
+        wMaxPacketSize     0x0040  1x 64 bytes
+        bInterval               0
+
+Bus 001 Device 004: ID 067b:2303 Prolific Technology, Inc. PL2303 Serial Port / Mobile Action MA-8910P
+Couldn't open device, some information will be missing
+Device Descriptor:
+  bLength                18
+  bDescriptorType         1
+  bcdUSB               1.10
+  bDeviceClass            0 
+  bDeviceSubClass         0 
+  bDeviceProtocol         0 
+  bMaxPacketSize0        64
+  idVendor           0x067b Prolific Technology, Inc.
+  idProduct          0x2303 PL2303 Serial Port / Mobile Action MA-8910P
+  bcdDevice            3.00
+  iManufacturer           1 Prolific Technology Inc.
+  iProduct                2 USB-Serial Controller
+  iSerial                 0 
+  bNumConfigurations      1
+  Configuration Descriptor:
+    bLength                 9
+    bDescriptorType         2
+    wTotalLength       0x0027
+    bNumInterfaces          1
+    bConfigurationValue     1
+    iConfiguration          0 
+    bmAttributes         0x80
+      (Bus Powered)
+    MaxPower              100mA
+    Interface Descriptor:
+      bLength                 9
+      bDescriptorType         4
+      bInterfaceNumber        0
+      bAlternateSetting       0
+      bNumEndpoints           3
+      bInterfaceClass       255 Vendor Specific Class
+      bInterfaceSubClass      0 
+      bInterfaceProtocol      0 
+      iInterface              0 
+      Endpoint Descriptor:
+        bLength                 7
+        bDescriptorType         5
+        bEndpointAddress     0x81  EP 1 IN
+        bmAttributes            3
+          Transfer Type            Interrupt
+          Synch Type               None
+          Usage Type               Data
+        wMaxPacketSize     0x000a  1x 10 bytes
+        bInterval               1
+      Endpoint Descriptor:
+        bLength                 7
+        bDescriptorType         5
+        bEndpointAddress     0x02  EP 2 OUT
+        bmAttributes            2
+          Transfer Type            Bulk
+          Synch Type               None
+          Usage Type               Data
+        wMaxPacketSize     0x0040  1x 64 bytes
+        bInterval               0
+      Endpoint Descriptor:
+        bLength                 7
+        bDescriptorType         5
+        bEndpointAddress     0x83  EP 3 IN
+        bmAttributes            2
+          Transfer Type            Bulk
+          Synch Type               None
+          Usage Type               Data
+        wMaxPacketSize     0x0040  1x 64 bytes
+        bInterval               0
+```
+
+Then add the appropriate rules under `/etc/udev/` to ensure they get a special static symlink. For example for the 
+above output the udev rule would look as follows.
+
+```
+SUBSYSTEM=="tty", ATTRS{idVendor}=="067b", ATTRS{idProduct}=="2303", SYMLINK+="ttyUSB-kenwood"
+SUBSYSTEM=="tty", ATTRS{idVendor}=="0403", ATTRS{idProduct}=="d011", ATTRS{serial}=="PT5690Y", SYMLINK+="ttyUSB-scs"
+```
+
 == Links
 
 * {Source on Github}[https://github.com/Syncleus/peak]

data/Rakefile

@@ -24,12 +24,12 @@ def dump_load_path
     end
 end
 
-gem 'json', '~> 1.8.3'
+gem 'json', '~> 2.5'
 
-gem 'bundler', '~> 1.7'
+gem 'bundler', '~> 2.2'
 require 'bundler'
 
-gem 'rake', '~> 11.3.0'
+gem 'rake', '~> 13.0'
 require 'rake/clean'
 require 'rake/testtask'
 

data/lib/peak/app_info.rb

@@ -1,3 +1,3 @@
 module Peak
-    VERSION = "1.0.2"
+    VERSION = "1.0.3"
 end

data/lib/peak/config_loader.rb

@@ -99,11 +99,16 @@ module Peak
                     end
                     tnc_port = port_section['tnc_port']
                     
-                    port_map[port_name] = TncPort.new(kiss_tnc, port_name, port_identifier, port_net, true, tnc_port)
+                    unless config_lookup_enforce(port_section, 'echo')
+                        return nil
+                    end
+                    echo_state = port_section['echo']
+                    
+                    port_map[port_name] = TncPort.new(kiss_tnc, port_name, port_identifier, port_net, echo_state, tnc_port)
                 end
             end
         end
         
         return port_map
     end
-end
+end

data/lib/peak/routing/route.rb

@@ -7,6 +7,7 @@ module Peak
                 @next_target = next_target
                 @config = config
                 @frame_port = frame_port
+                @destination_port = frame_port
 
                 @port_info = {}
                 config.each do |section_name, section_content|
@@ -200,30 +201,6 @@ module Peak
                 end
             end
 
-            protected
-            def filter(*args)
-                args = Rules.args_parser(*args)
-                do_next_target(args[:next_target])
-            end
-
-            protected
-            def consume_next_hop(*args)
-                args = Rules.args_parser(*args)
-
-                if has_next_hop? and args[:condition]
-                    catch(:done) do
-                        @frame[:path].each do |hop|
-                            unless hop.end_with? '*'
-                                hop << '*'
-                                throw :done
-                            end
-                        end
-                    end
-                end
-                
-                do_next_target(args[:next_target])
-            end
-
             private
             def self.consume_new_paradigm(hop)
                 hop_split = hop.split('-')
@@ -237,6 +214,12 @@ module Peak
                 end
             end
 
+            protected
+            def filter(*args)
+                args = Rules.args_parser(*args)
+                do_next_target(args[:next_target])
+            end
+
             protected
             def route(*args, preemptive: nil)
                 args = Rules.args_parser(*args)
@@ -266,10 +249,13 @@ module Peak
                     end
 
 
+                    target = nil
                     next_hop = select_next_hop(@frame[:path])
                     if all_my_names.include? next_hop.upcase or Rules.is_hop_old_paradigm?(next_hop, old_paradigm)
+                        target = next_hop.dup
                         next_hop << '*'
                     elsif Rules.is_hop_new_paradigm?(next_hop, new_paradigm)
+                        target = next_hop.dup
                         Rules.consume_new_paradigm(next_hop)
                     end
 
@@ -280,11 +266,24 @@ module Peak
                             if detected
                                 hop << '*'
                             elsif identifiers.include? hop.upcase
+                                target = hop.dup
                                 hop << '*'
                                 detected = true
                             end
                         end
                     end
+
+                    if target
+                        @port_info.each do |name, info|
+                            identifier = info[:port_identifier].upcase
+                            net_freq = info[:port_net]
+                            net_band = net_freq.dup.gsub(/M\d{0,3}$/i, 'M')
+
+                            if target == identifier or target == net_freq or target == net_band
+                                @destination_port = @frame_port
+                            end
+                        end
+                    end
                 end
 
                 do_next_target(args[:next_target])
@@ -610,7 +609,7 @@ module Peak
             end
 
             public
-            attr_reader :next_target, :frame
+            attr_reader :next_target, :frame, :destination_port
         end
 
         class Route
@@ -618,17 +617,17 @@ module Peak
 
             public
             def self.inbound_chain(&block)
-                @@chains[:inbound] = {:target => :input, :block => block}
+                @@chains[:inbound] = block
             end
 
             public
             def self.outbound_chain(&block)
-                @@chains[:outbound] = {:target => :output, :block => block}
+                @@chains[:outbound] = block
             end
 
             public
-            def self.side_chain(name, target, &block)
-                @@chains[name] = {:target => target, :block => block}
+            def self.side_chain(name, &block)
+                @@chains[name] = block
             end
 
             public
@@ -648,10 +647,9 @@ module Peak
             filter :output # if this werent here packet would be dropped
         }
 
-        Route.side_chain(:forward, :output) {
+        Route.side_chain(:forward) {
             filter seen?, :drop
-            filter future_hop_me?, :pass, :drop
-            route :output
+            route future_hop_me?, :output, :drop
         }
 
         # ==== Exiting custom code ========
@@ -668,7 +666,7 @@ module Peak
                 more = true
                 while more and rules.next_target != :input and rules.next_target != :output and rules.next_target != :drop
                     catch(:new_target) do
-                        rules.instance_eval &@@chains[rules.next_target][:block]
+                        rules.instance_eval &@@chains[rules.next_target]
                         more = false
                     end
                 end
@@ -678,7 +676,7 @@ module Peak
                 end
 
                 {
-                    :output_target => rules.next_target == :output ? name : nil,
+                    :output_target => rules.next_target == :output ? rules.destination_port : nil,
                     :frame => rules.frame
                 }
             end

data/lib/peak/tnc_port.rb

@@ -3,7 +3,7 @@ require 'peak/echo'
 module Peak
     class TncPort
         protected
-        def initialize(data_stream, name, identifier, net, echo_frames=false, port=0)
+        def initialize(data_stream, name, identifier, net, echo_frames = 'none', port=0)
             @data_stream = data_stream
             @port = port
             @name = name
@@ -25,7 +25,7 @@ module Peak
         public
         def read(*args, **kwargs)
             read_frame = @data_stream.read(*args, **kwargs)
-            if @echo_frames and read_frame
+            if (@echo_frames == 'all' or @echo_frames == 'in') and read_frame
                 Peak::echo_color_frame(read_frame, @name, true)
             end
             return read_frame
@@ -34,11 +34,11 @@ module Peak
         public
         def write(frame, *args, **kwargs)
             @data_stream.write(frame, @port, *args, **kwargs)
-            if @echo_frames and frame
+            if (@echo_frames == 'all' or @echo_frames == 'out') and frame
                 Peak::echo_color_frame(frame, @name, false)
             end
         end
 
         attr_reader :name, :net, :port, :identifier
     end
-end
+end

data/peak.gemspec

@@ -30,10 +30,11 @@ Gem::Specification.new do |spec|
     spec.require_paths = ['lib']
 
     spec.add_dependency 'colorize', '~> 0.8'
-    spec.add_dependency 'methadone', '~> 1.9'
+    spec.add_dependency 'methadone', '~> 2.0'
     spec.add_dependency 'apex-aprs', '~> 1.0'
-    spec.add_development_dependency 'bundler', '~> 1.7'
-    spec.add_development_dependency 'rake', '~> 11.3'
-    spec.add_development_dependency 'rdoc', '~> 4.2'
-    spec.add_development_dependency 'aruba', '~> 0.14'
+    spec.add_dependency 'aprs_is', '~> 0.1'
+    spec.add_development_dependency 'bundler', '~> 2.2'
+    spec.add_development_dependency 'rake', '~> 13.0'
+    spec.add_development_dependency 'rdoc', '~> 6.3'
+    spec.add_development_dependency 'aruba', '~> 2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: peak
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Jeffrey Phillips Freeman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-09 00:00:00.000000000 Z
+date: 2021-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: apex-aprs
   requirement: !ruby/object:Gem::Requirement
@@ -52,62 +52,76 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: aprs_is
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '6.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '6.3'
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '2.0'
 description: Reference implementation for the APEX Radio protocol, which is itself
   an extension to the APRS protocol.
 email:
@@ -160,8 +174,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.2.5
 signing_key: 
 specification_version: 4
 summary: Reference implementation for the APEX Radio protocol, an extension to APRS.