peak 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0bf3fe01adb129593454ad6d8c518e0a0591d6e1
-  data.tar.gz: 9e2bc0959f86ccd9e1fdf9e56742361548953bad
+  metadata.gz: 2b395c9e001b9be92ec7523d17b639f45551d64b
+  data.tar.gz: bbb594e7ea2200d8a9452be19ef03115b21aecee
 SHA512:
-  metadata.gz: 3ae70322824fd30cd1556bae9c37fba727051839ab71cceedddc738e4cf4d734f0af843140b28b358596ae457ec75531ebd1d99ce17c6696fdb98b2be5c8be89
-  data.tar.gz: 084a0bdd8b68cecfac23a4da1e9a32815f0a6bf8d2af5a4c9782edbfc15a8a4ac9a7cfb39cce3fedd97725006dda893b91f6aab4d986d47f030576e85cbed503
+  metadata.gz: 5d45e7971b96c7996477fd314f19bb6763e9e0e2dfbebabf211f3d7aeb6dc548163771a09c50ec13b2f67db851dd4e17ed0d69749861e44743e5e98ac4ddd0ec
+  data.tar.gz: f61760fa1c991287e410e042dbb3dca2d1f1397468c6599b86df77f50cc9a04ed6befd70d6493a10e9cdb1336d57d7ca263857b995e87dfd3e5e44c8748489fa

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 1.0.1
+
+* Added beacon plugin to transmit beacon every 10 minutes.
+* Added id plugin to transmit id packet every 10 minutes.
+* Added status plugin to transmit status packet every 10 minutes.
+* Made plugin architecture multi-threaded.
+
 ## 1.0.0
 
 * Initial release

data/README.rdoc

@@ -1,19 +1,47 @@
-= peak - DESCRIBE YOUR GEM
+= Peak
 
-Author::  YOUR NAME (YOUR EMAIL)
-Copyright:: Copyright (c) 2016 YOUR NAME
+{<img src="https://badge.fury.io/rb/peak.svg" alt="Gem Version" />}[https://badge.fury.io/rb/peak]
 
+Author::  Jeffrey Phillips Freeman, WI2ARD (freemo@gmail.com)
+Copyright:: Copyright (c) 2016 Syncleus, Inc.
 
-DESCRIBE YOUR GEM HERE
+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
+for digipeating, compatible with most AX.25 KISS TNC devices, and utilizing the full APEX stack.
 
-== Links
+For more information on the project please check out {the project's home page}[http://apexprotocol.com/].
+
+Peak is Free and Open-source software under Apache Software License v2
+
+== Installation
+
+Install the application using gem.
+
+    gem install peak
+
+== Running the app
 
-* {Source on Github}[LINK TO GITHUB]
-* RDoc[LINK TO RDOC.INFO]
+Once installed copy the peak.conf.example file over to peak.conf in the /etc directory, then edit the file and replace
+it with your details. Next just run the application with the following command.
 
-== Install
+    peak run
 
-== Examples
+There isn't much to the application right now, the application is still pre-release so more features and configuration
+options should be added soon. For now the application will display all packets read in and send out a status, id, and
+beacon packet every 10 minutes.
+
+This is Free software: Apache License v2
+
+== Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the
+version number in `app_info.rb`, and then run `bundle exec rake release`, 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).
+
+== Links
 
-== Contributing
+* {Source on Github}[https://github.com/Syncleus/peak]
 

data/lib/peak.rb

@@ -1,7 +1,3 @@
-require 'kiss/kiss_serial'
-require 'apex/aprs_kiss'
-require 'peak/app_info'
-require 'peak/plugins/plugin_factory'
 require 'peak/echo'
 require 'peak/config_loader'
 require 'peak/plugin_loader'
@@ -12,31 +8,31 @@ module Peak
         config = find_config(true)
         port_map = init_port_map(config)
         
-        activated_plugins = []
+        active_plugins = {}
         plugins = load_plugins
         plugins.each do |plugin|
-            activated_plugin = plugin.new(nil, nil, nil)
-            activated_plugins << activated_plugin
-            activated_plugin.run
+            active_plugin = plugin.new(config, port_map, nil)
+            active_plugin_thread = Thread.new {
+                active_plugin.run
+            }
+            active_plugins[active_plugin] = active_plugin_thread
         end
 
-        # Transmit a beacon when we first start
-        beacon_frame = {:source => 'WI2ARD-2',
-                        :destination => 'APRS',
-                        :path => ['WIDE1-1', 'WIDE2-2'],
-                        :text => '!/:=i@;N.G& --PHG5790/G/D R-I-R H24 C30'}
-        port_map.values.each do |tnc_port|
-            tnc_port.write(beacon_frame)
-        end
-
-        # Display any packets we read in.
+        # Handle any packets we read in.
         while true
+            something_read = false
             port_map.values.each do |tnc_port|
                 frame = tnc_port.read
-                unless frame
-                    sleep(1)
+                if frame
+                    something_read = true
+                    active_plugins.each_key do |plugin|
+                        plugin.handle_packet(frame, tnc_port)
+                    end
                 end
             end
+            unless something_read
+                sleep(1)
+            end
         end
     end
 end

data/lib/peak/app_info.rb

@@ -1,3 +1,3 @@
 module Peak
-    VERSION = "1.0.0"
+    VERSION = "1.0.1"
 end

data/lib/peak/config_loader.rb

@@ -1,5 +1,7 @@
 require 'yaml'
 require 'peak/tnc_port'
+require 'apex/aprs_kiss'
+require 'kiss'
 
 module Peak
     def self.find_config(verbose, config_paths=[])

data/lib/peak/plugins/apex_paradigm.rb

@@ -1,27 +1,23 @@
 module Peak
     module Plugins
-        class PeakParadigm
+        class ApexParadigm
             protected
             def initialize(config, port_map, aprsis)
-                puts 'PeakParadigm inited'
             end
             
             public
             def run
-                puts 'PeakParadigm ran'
             end
             
             public
             def stop
-                puts 'PeakParadigm stop'
             end
             
             public
-            def handle_packet(frame, recv_port, recv_port_name)
-                puts 'PeakParadigm handled packet'
+            def handle_packet(frame, recv_port)
             end
         end
 
-        PluginFactory.register_plugin(PeakParadigm)
+        PluginFactory.register_plugin(ApexParadigm)
     end
 end

data/lib/peak/plugins/beacon.rb

@@ -3,22 +3,66 @@ module Peak
         class Beacon
             protected
             def initialize(config, port_map, aprsis)
-                puts 'beacon inited'
+                @port_configs = {}
+                @aprsis = aprsis
+                @running = false
+                
+                config.each do |section_name, section_content|
+                    if section_name.start_with?('TNC ')
+                        tnc_name = section_name.strip.split(' ')[1].strip
+                        (1..section_content['port_count']).each do |port_id|
+                            port_name = tnc_name + '-' + port_id.to_s
+                            port = port_map[port_name]
+                            port_section = 'PORT ' + port_name
+                            @port_configs[port] = {:beacon_text => config[port_section]['beacon_text'],
+                                                   :beacon_path => config[port_section]['beacon_path']
+                            }
+                        end
+                    end
+                end
+            end
+            
+            private
+            def self.now
+                Time.now.to_i
             end
             
             public
             def run
-                puts 'beacon ran'
+                @running = true
+        
+                # Don't do anything in the first 30 seconds
+                last_trigger = Beacon::now
+                while @running and Beacon::now - last_trigger < 30
+                    sleep(1)
+                end
+        
+                # run every 600 second
+                last_trigger = Beacon::now
+                while @running
+                    if Beacon::now - last_trigger >= 600
+                        last_trigger = Beacon::now
+                        @port_configs.each do |port, port_config|
+                            frame = {:source => port.identifier,
+                                     :destination => 'APRS',
+                                     :path => port_config[:beacon_path],
+                                     :text => port_config[:beacon_text]
+                            }
+                            port.write(frame)
+                        end
+                    else
+                        sleep(1)
+                    end
+                end
             end
             
             public
             def stop
-                puts 'beacon stop'
+                @running = false
             end
             
             public
-            def handle_packet(frame, recv_port, recv_port_name)
-                puts 'Beacon handled packet'
+            def handle_packet(frame, recv_port)
             end
         end
 

data/lib/peak/plugins/id.rb

@@ -3,22 +3,66 @@ module Peak
         class Id
             protected
             def initialize(config, port_map, aprsis)
-                puts 'Id inited'
+                @port_configs = {}
+                @aprsis = aprsis
+                @running = false
+        
+                config.each do |section_name, section_content|
+                    if section_name.start_with?('TNC ')
+                        tnc_name = section_name.strip.split(' ')[1].strip
+                        (1..section_content['port_count']).each do |port_id|
+                            port_name = tnc_name + '-' + port_id.to_s
+                            port = port_map[port_name]
+                            port_section = 'PORT ' + port_name
+                            @port_configs[port] = {:id_text => config[port_section]['id_text'],
+                                                   :id_path => config[port_section]['id_path']
+                            }
+                        end
+                    end
+                end
             end
-            
+    
+            private
+            def self.now
+                Time.now.to_i
+            end
+    
             public
             def run
-                puts 'Id ran'
+                @running = true
+        
+                # Don't do anything in the first 60 seconds
+                last_trigger = Id::now
+                while @running and Id::now - last_trigger < 60
+                    sleep(1)
+                end
+        
+                # run every 600 second
+                last_trigger = Id::now
+                while @running
+                    if Id::now - last_trigger >= 600
+                        last_trigger = Id::now
+                        @port_configs.each do |port, port_config|
+                            frame = {:source => port.identifier,
+                                     :destination => 'ID',
+                                     :path => port_config[:id_path],
+                                     :text => port_config[:id_text]
+                            }
+                            port.write(frame)
+                        end
+                    else
+                        sleep(1)
+                    end
+                end
             end
-            
+    
             public
             def stop
-                puts 'Id stop'
+                @running = false
             end
-            
+    
             public
-            def handle_packet(frame, recv_port, recv_port_name)
-                puts 'Id handled packet'
+            def handle_packet(frame, recv_port)
             end
         end
 

data/lib/peak/plugins/status.rb

@@ -3,22 +3,66 @@ module Peak
         class Status
             protected
             def initialize(config, port_map, aprsis)
-                puts 'Status inited'
+                @port_configs = {}
+                @aprsis = aprsis
+                @running = false
+        
+                config.each do |section_name, section_content|
+                    if section_name.start_with?('TNC ')
+                        tnc_name = section_name.strip.split(' ')[1].strip
+                        (1..section_content['port_count']).each do |port_id|
+                            port_name = tnc_name + '-' + port_id.to_s
+                            port = port_map[port_name]
+                            port_section = 'PORT ' + port_name
+                            @port_configs[port] = {:status_text => config[port_section]['status_text'],
+                                                   :status_path => config[port_section]['status_path']
+                            }
+                        end
+                    end
+                end
             end
-            
+    
+            private
+            def self.now
+                Time.now.to_i
+            end
+    
             public
             def run
-                puts 'Status ran'
+                @running = true
+        
+                # Don't do anything in the first 90 seconds
+                last_trigger = Status::now
+                while @running and Status::now - last_trigger < 90
+                    sleep(1)
+                end
+        
+                # run every 600 second
+                last_trigger = Status::now
+                while @running
+                    if Status::now - last_trigger >= 600
+                        last_trigger = Status::now
+                        @port_configs.each do |port, port_config|
+                            frame = {:source => port.identifier,
+                                     :destination => 'APRS',
+                                     :path => port_config[:status_path],
+                                     :text => port_config[:status_text]
+                            }
+                            port.write(frame)
+                        end
+                    else
+                        sleep(1)
+                    end
+                end
             end
-            
+    
             public
             def stop
-                puts 'Status stop'
+                @running = false
             end
-            
+    
             public
-            def handle_packet(frame, recv_port, recv_port_name)
-                puts 'Status handled packet'
+            def handle_packet(frame, recv_port)
             end
         end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: peak
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Jeffrey Phillips Freeman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-04 00:00:00.000000000 Z
+date: 2016-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -120,7 +120,6 @@ files:
 - CHANGELOG.md
 - Gemfile
 - LICENSE
-- README.md
 - README.rdoc
 - Rakefile
 - bin/console

data/README.md

@@ -1,36 +0,0 @@
-# Peak
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/peak`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'peak'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install peak
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, 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).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/Syncleus/peak.
-