bolt_train_runner 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c5b930e3262ec9ac6eb6989949bbdb71e9ceefecad32ef7abfad03486bef32d0
+  data.tar.gz: 7c5ea7ff98b82eadc1c3111e67c425abb6e43ae518b66ee2c996fa14f27368da
+SHA512:
+  metadata.gz: 5a29ee08a95f7c76bef3972a9595b344f1d04cc511fa7ce733a030350e0a7bc82fb1d83d50c3e3ee9c125ca4eba0aa7e43b188200f31175c5f054a93e5e54a9f
+  data.tar.gz: 2e7bf384b4e5cba13285c1972fe7fa1c80efa299ac055cee2d1d594aac8be9435ee14d2589314fe882a65e3a43d4dbfc8800579f5a6893d83f7fa3cbb0e1517a

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Nick Burgan-Illig
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# BoltTrainRunner
+
+This is a CLI tool for communicating with the Bolt Train JMRI JSON server. It will allow you to control the Bolt train in real time. It will also serve as the executor, reading session files laid down by the bolt-train-api server, and sending the appropriate JMRI commands to implement the commands in those session files.
+
+## Installation
+
+This is packaged as a gem on RubyGems. So all you need to do to install is:
+
+```ruby
+gem install bolt_train_runner
+```
+
+## Usage
+
+To start the program, simply run `bolt_train` from the command line. This will start the bolt-train-runner shell.  Type `help` for a list of commands, and `<command> help` for information on how to use each command.
+
+The first command you must run before all others is `connect`.  This will open a websocket connection to the JMRI JSON server. After successfully connecting, the server you connected to will be saved to `~/.bolttrain.conf`, so you will not need to type the server information in again.
+
+Turning debug mode on by doing `debug on` will print the JSON blobs sent to and received from the the JMRI JSON server.
+
+## Development
+
+After checking out the repo, do a `bundle install`. Then, you can do `bundle exec rake build` to create the gem in the `pkg` folder. You may then install this local copy of the gem using `gem install`.
+
+Using `bundle exec rake install` will probably also work in place of the above steps.
+
+To release a new version of the gem, do `bundle exec rake release`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/bolt_train_runner.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/bin/bolt_train

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
+
+require 'bolt_train_runner'
+
+BoltTrainRunner.new.run

data/lib/bolt_train_runner.rb

@@ -0,0 +1,72 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'colorize'
+require 'bolt_train_runner/comms'
+
+# Load all commands
+Dir[File.join(File.absolute_path(__dir__) + '/bolt_train_runner/commands') + "/**/*.rb"].each do |file|
+  require file
+end
+
+# TODO:
+#   Add a lot more error handling
+#   Add thread for consuming session files and issuing commands
+#   Figure out best way to verify commands worked given that responses from JMRI are async
+#   Figure out why it gets multiple messages back each time
+#   Make debug output show what method/command the output is from
+#   Make debug output not screw with the console prompt
+#   Changing debug on or off and reconnecting doesn't actually seem to work to change debug level
+#   Add a way to log to a file in addition to the console
+
+
+class BoltTrainRunner
+
+  def run
+    comms = nil
+    puts 'Welcome to the Bolty McBoltTrain Runner! Choo choo!'.cyan
+    puts 'To list all commands, enter "help"'.cyan
+    puts 'For help with a specific command, enter "<command> help"'.cyan
+    puts 'First order of business: run "connect" to connect to the JMRI server'.cyan
+    loop do
+      print '> '
+      input = gets.chomp
+      args = input.split(' ')
+      command = args.shift
+      case command
+      when /^help$/i
+        help
+      when /^connect$/i
+        newcomms = Commands.connect(args)
+        comms = newcomms if newcomms
+      when /^disconnect$/i
+        Commands.disconnect(comms)
+        comms = nil
+      when /^debug$/i
+        Commands.debug(args)
+      when /^power$/i
+        Commands.power(args, comms)
+      when /^throttle$/i
+        Commands.throttle(args, comms)
+      when /^move$/i
+        Commands.move(args, comms)
+      when /^exit$/i
+        Commands.exit_program(comms)
+      else
+        puts "Unknown command: #{command}".red
+      end
+    end
+  end
+
+  def help
+    puts 'Available commands:'.cyan
+    puts 'help - This help text'.cyan
+    puts 'connect - Connect to the Bolt Train JMRI JSON server'.cyan
+    puts 'disconnect - Disconnect from the JMRI server'.cyan
+    puts 'power - Turn power on or off to the train'.cyan
+    puts 'throttle - Set throttle to a value between 0 and 10'.cyan
+    puts 'move - Move the train in the given direction at the given speed for a certain length of time'.cyan
+    puts 'exit - Exit program'.cyan
+  end
+
+end

data/lib/bolt_train_runner/commands/connect.rb

@@ -0,0 +1,32 @@
+require 'bolt_train_runner/conf'
+require 'bolt_train_runner/comms'
+require 'colorize'
+
+module Commands
+  def self.connect(args)
+    conf = Conf.load_conf
+    if !args.empty? && args[0] =~ /help/i
+      puts 'Command: connect'.cyan
+      puts 'Syntax: connect [server:port]'.cyan
+      puts 'If called with no argument, it will attempt to use the last specified server:port'.cyan
+      puts 'If this is the first time connect was called with no arguments, it will prompt you for the server and port'.cyan
+      return
+    end
+    if args.empty?
+      server = conf['server']
+      unless server
+        print 'Please enter server:port [10.0.7.82:12080] > '
+        server = gets.chomp
+        server = '10.0.7.82:12080' if server.empty?
+      end
+    else
+      server = args[0]
+    end
+    conf['server'] = server
+    Conf.save_conf(conf)
+
+    puts "Connecting to ws://#{server}/json/".green
+    comms = Comms.new(server)
+    return comms
+  end
+end

data/lib/bolt_train_runner/commands/debug.rb

@@ -0,0 +1,24 @@
+require 'colorize'
+require 'bolt_train_runner/conf'
+
+module Commands
+  def self.debug(args)
+    if args.empty? || args[0] =~ /help/i
+      puts 'Command: debug'.cyan
+      puts 'Syntax: debug <on|off>'.cyan
+      #Should fix this at some point 
+      puts 'Turns debug logging on or off. Will require disconnecting and reconnecting to take effect.'.cyan
+      puts 'Choice will be persistent across program invocations.'.cyan
+      return
+    end
+    state = args[0]
+    if !['on','off'].include?(state)
+      puts 'Debug must be called with either "on" or "off"'.red
+      return
+    end
+    conf = Conf.load_conf
+    conf['debug'] = state == 'on'
+    Conf.save_conf(conf)
+    puts "Debug mode #{state}".green
+  end
+end

data/lib/bolt_train_runner/commands/disconnect.rb

@@ -0,0 +1,13 @@
+require 'bolt_train_runner/comms'
+require 'colorize'
+
+module Commands
+  def self.disconnect(comms)
+    if comms.nil?
+      puts 'Not currently connected'.red
+      return
+    end
+    comms.disconnect
+    puts 'Disconnected'.green
+  end
+end

data/lib/bolt_train_runner/commands/exit.rb

@@ -0,0 +1,12 @@
+require 'colorize'
+require 'bolt_train_runner/comms'
+
+module Commands
+  def self.exit_program(comms)
+    if comms
+      comms.disconnect
+    end
+    puts 'Seeya later!'.green
+    exit 0
+  end
+end

data/lib/bolt_train_runner/commands/move.rb

@@ -0,0 +1,65 @@
+require 'bolt_train_runner/comms'
+require 'colorize'
+
+module Commands
+  def self.move(args, comms)
+    unless comms
+      puts 'Please connect first'.red
+      return
+    end
+    if args.empty? || args[0] =~ /help/i
+      puts 'Command: move'.cyan
+      puts 'Syntax: move <forward|reverse> <speed 0-10> <time 1-60>'.cyan
+      puts 'Move the train the given direction at the given speed for the given number of seconds'.cyan
+      puts 'Note that the power must be on first'.cyan
+      return
+    end
+
+    if args.length < 3
+      puts 'Please provide direction, speed, and time'.red
+      return
+    end
+    direction = args[0]
+    speed = args[1].to_i
+    time = args[2].to_i
+    unless ['forward','reverse'].include?(direction)
+      puts 'Please provide "forward" or "reverse" for direction'.red
+      return
+    end
+    if speed < 0 or speed > 10
+      puts 'Please select a speed between 0 and 10'.red
+      return
+    end
+    if time < 1 or time > 60
+      puts 'Please select a time between 1 and 60 seconds'.red
+      return
+    end
+
+    message = {
+      'type'   => 'throttle',
+      'method' => 'put',
+      'data'   => {
+        'throttle' => 'bolttrain',
+        'address'  => '6871',
+        'speed'    => "#{speed/10.0}",
+        'forward'  => "#{direction == 'forward'}"
+      }
+    }
+    comms.send_message(message)
+    puts "Train moving #{direction} at speed #{speed}".green
+    puts "Waiting #{time} seconds".green
+    sleep(time)
+    puts "Stopping train".green
+    message = {
+      'type'   => 'throttle',
+      'method' => 'post',
+      'data'   => {
+        'throttle' => 'bolttrain',
+        'address'  => '6871',
+        'speed'    => '0'
+      }
+    }
+    comms.send_message(message)
+    puts 'Move complete'.green
+  end
+end

data/lib/bolt_train_runner/commands/power.rb

@@ -0,0 +1,34 @@
+require 'bolt_train_runner/comms'
+require 'colorize'
+
+module Commands
+  def self.power(args, comms)
+    unless comms
+      puts 'Please connect first'.red
+      return
+    end
+    if args.empty? || args[0] =~ /help/i
+      puts 'Command: power'.cyan
+      puts 'Syntax: power <on|off>'.cyan
+      puts 'Turns power to the train on or off. Must first be connected.'.cyan
+      return
+    end
+    state = args[0]
+    unless ['on','off'].include?(state)
+      puts 'Please provide either "on" or "off"'.red
+      return
+    end
+
+    vals = {'on' => '2', 'off' => '4'}
+    value = vals[state]
+    message = {
+      'type'   => 'power',
+      'method' => 'put',
+      'data'   => {
+        'name'  => 'LocoNet',
+        'state' => value
+      }
+    }
+    comms.send_message(message)
+  end
+end

data/lib/bolt_train_runner/commands/throttle.rb

@@ -0,0 +1,46 @@
+require 'bolt_train_runner/comms'
+require 'colorize'
+
+module Commands
+  def self.throttle(args, comms)
+    unless comms
+      puts 'Please connect first'.red
+      return
+    end
+    if args.empty? || args[0] =~ /help/i
+      puts 'Command: throttle'.cyan
+      puts 'Syntax: throttle <0-10> [forward|reverse]'.cyan
+      puts 'Sets the throttle to the given level, between 0 and 10. May optionally provide a direction.'.cyan
+      puts 'Note that power must be on first for this to take effect.'.cyan
+      return
+    end
+
+    speed = args[0].to_i
+    if speed < 0 or speed > 10
+      puts 'Please select a speed between 0 and 10'.red
+      return
+    end
+    direction = nil
+    if args.length > 1
+      direction = args[1]
+      unless ['forward','reverse'].include?(direction)
+        puts 'Direction must be either "forward" or "reverse"'.red
+        return
+      end
+    end
+
+    message = {
+      'type'   => 'throttle',
+      'method' => 'post',
+      'data'   => {
+        'throttle' => 'bolttrain',
+        'address'  => '6871',
+        'speed'    => "#{speed/10.0}",
+      }
+    }
+    message['data']['forward'] = direction == 'forward' if direction
+    comms.send_message(message)
+    direction_string = direction.nil? ? '' : " with direction #{direction}"
+    puts "Throttle set to #{speed}#{direction_string}".green
+  end
+end

data/lib/bolt_train_runner/comms.rb

@@ -0,0 +1,65 @@
+require 'websocket-client-simple'
+require 'json'
+require 'colorize'
+require 'bolt_train_runner/conf'
+require 'pry-byebug'
+
+# Sending and receiving responses is a little bit funky
+# Since we have to receive messages asynchronously, and because
+# the server sometimes sends back more than one message to a given
+# command, and because the server will send out status messages
+# periodically, it is hard to verify that the command you sent
+# was received correctly. So for now, it's just sending the command
+# and not checking the result.
+
+class Comms
+
+  @ws = nil
+  @heartbeat_thread = nil
+  @consumer_thread = nil
+  @kill_threads = false
+  @queue = []
+
+  def initialize(server)
+    debug = Conf.debug
+    @ws = WebSocket::Client::Simple.connect("ws://#{server}/json/")
+    @ws.on :message do |msg|
+      data = JSON.parse(msg.data)
+      puts "Received #{data}" if (data['type'] != 'hello') if debug
+    end
+    @ws.on :error do |e|
+      puts "Error from Websocket: #{e}".red
+    end
+
+    @heartbeat_thread = Thread.new { run_heartbeat }
+  end
+
+  def disconnect
+    @kill_threads = true
+    @heartbeat_thread.join if @heartbeat_thread
+  end
+
+  def run_heartbeat
+    count = 0
+    check_interval = 0.5
+    ping_interval = 10
+    while !@kill_threads
+      count = count % ping_interval
+      if count == 0
+        message = send_message({'type'=>'ping'})
+      end
+      count += check_interval
+      sleep(check_interval)
+    end
+  end
+
+  # Expects a hash with the correctly formed message, which
+  # will get transformed to a JSON string by this function
+  def send_message(message)
+    debug = Conf.debug
+    message = JSON.generate(message)
+    puts "Sending #{message}" if debug
+    @ws.send(message)
+  end
+
+end

data/lib/bolt_train_runner/conf.rb

@@ -0,0 +1,21 @@
+require 'yaml'
+
+class Conf
+  attr_reader :CONFFILE
+
+  CONFFILE = File.expand_path('~/.bolttrain.conf')
+  File.write(CONFFILE, "---\n{}") unless File.exist?(CONFFILE)
+
+  def self.load_conf
+    YAML.load_file(CONFFILE)
+  end
+
+  def self.save_conf(conf)
+    File.write(CONFFILE, conf.to_yaml)
+  end
+
+  def self.debug
+    conf = load_conf
+    conf['debug'] || false
+  end
+end

data/lib/bolt_train_runner/version.rb

@@ -0,0 +1,3 @@
+module BoltTrainRunner
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: bolt_train_runner
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nick Burgan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: websocket-client-simple
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This is a command line tool for talking to the Bolt Train JMRI JSON Server.
+  It includes a method for installing it as a service, working in concert with the
+  Bolt Train API server.
+email:
+- nickb@puppet.com
+executables:
+- bolt_train
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- bin/bolt_train
+- lib/bolt_train_runner.rb
+- lib/bolt_train_runner/commands/connect.rb
+- lib/bolt_train_runner/commands/debug.rb
+- lib/bolt_train_runner/commands/disconnect.rb
+- lib/bolt_train_runner/commands/exit.rb
+- lib/bolt_train_runner/commands/move.rb
+- lib/bolt_train_runner/commands/power.rb
+- lib/bolt_train_runner/commands/throttle.rb
+- lib/bolt_train_runner/comms.rb
+- lib/bolt_train_runner/conf.rb
+- lib/bolt_train_runner/version.rb
+homepage: https://github.com/puppetlabs/bolt-train-runner
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: CLI/Service for talking to the Bolt Train JMRI JSON Server
+test_files: []