hwping 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a6cbddb5d50553a985d48cda712b992ea667ede9
+  data.tar.gz: 72840576bfc2f86a92414f573f957ccdb040b4aa
+SHA512:
+  metadata.gz: bbd0ea2f0c0f574e2d144601184c3c93c9f2bdd9bff8f85951164418ca2fce61be5a06441225545288d3cb725b9a3468d40d42d1d43f434f9fa60426959e4dce
+  data.tar.gz: af2ce63c355ff50cee63a95f92f60c786eb15b6e449339d5ab99ba6fdc5937f8e4996a6c46e8bad70b95a076e609a16a67c45a5a857b1733160f2fc7a349476d

data/bin/hwping

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'yaml'
+require 'hwping'
+
+# Parse arguments
+options = {}
+OptionParser.new do |opts|
+  opts.version = HWPing::VERSION
+  opts.program_name = HWPing::APP_NAME
+  opts.banner = 'Usage: hwping [options]'
+  opts.on('-c', '--config-file file.yml', "Specify which configuration file you want to use instead of the default config.yml") do |v|
+    options[:config] = v
+  end
+end.parse!
+
+# Open the configuration
+file = options.fetch(:config, HWPing::CONFIG_FILE)
+config = YAML.load_file(file)
+
+# Run the application
+app = HWPing::HWPing.new(config)
+app.start
+
+# Stop the bot and save the configuration file
+at_exit do
+  app.stop
+  File.open(file, 'w') do |f|
+    YAML.dump(app.config, f)
+  end
+end

data/lib/hwping/bot.rb

@@ -0,0 +1,67 @@
+require 'cinch'
+
+module HWPing
+  class Bot
+
+    MESSAGES = {
+      :unauthorized => "Sorry, you're unauthorized to use this bot!",
+      :firing       => 'Firing rocket in 5 seconds!',
+      :notarget     => 'Unknown target!',
+      :fire         => 'Rocket launch initiated!',
+      :reset        => 'Launcher set back to default position!',
+      :position     => 'Current position: %d %d',
+      :target_list  => 'Available targets: %s',
+      :target_get   => "Target's position: %d %d",
+      :target_del   => 'Target successfully deleted!',
+      :target_set   => "Target's position saved at: %d %d",
+      :move         => 'Move operation finished!',
+      :badcommand   => "Unknown command, type 'help' for further information!",
+      :help         => "Hardware Pinger\n
+        Usage in a channel: hwping <target>\n
+        Available commands in private:\n
+          help\n
+          fire\n
+          position\n
+          up|down|left|right\n
+          reset\n
+          target list\n
+          target set <nick> <right> <up>\n
+          target get <nick>\n
+          target del <nick>\n"
+    }
+
+    # Initialize a bot and return with its Cinch instance
+    def initialize(handler, config = {})
+      @nick     = config.nick
+      @server   = config.server
+      @port     = config.port
+      @channels = config.channels.map { |m| "\##{m}"}
+      @handler  = handler
+      return setup_bot()
+    end
+
+  private
+    def setup_bot
+      bot = Cinch::Bot.new do |b|
+        configure do |c|
+          c.nick     = @nick
+          c.server   = @server
+          c.port     = @port
+          c.channels = @channels
+        end
+
+        # For channel mesages, just reply with the matching message
+        on :channel, /^hwping/ do |e|
+          r = @handler.channel(e)
+          e.reply(MESSAGES[r])
+        end
+
+        # For private messages, build a reply message from the format strinc and the passed variables
+        on :private do |e|
+          (r, *f) = @handler.message(e)
+          e.reply(MESSAGES[r] % f)
+        end
+      end
+    end
+  end
+end

data/lib/hwping/config.rb

@@ -0,0 +1,24 @@
+module HWPing
+  class Config
+
+    attr_reader   :server
+    attr_reader   :port
+    attr_reader   :nick
+    attr_reader   :channels
+    attr_reader   :auth
+    attr_accessor :targets
+
+    def initialize(hash = {})
+      @server   = hash.fetch(:server,   'irc.freenode.net')
+      @port     = hash.fetch(:port,     6667)
+      @nick     = hash.fetch(:nick,     'hwping')
+      @channels = hash.fetch(:channels, ['hwping-test'])
+      @auth     = hash.fetch(:auth    , [])
+      @targets  = hash.fetch(:targets,  [])
+    end
+
+    def to_hash
+      Hash[instance_variables.map { |name| [name[1..-1], instance_variable_get(name)] }]
+    end
+  end
+end

data/lib/hwping/constants.rb

@@ -0,0 +1,6 @@
+module HWPing
+  VERSION = '0.0.1'
+  APP_NAME = 'hwping'
+  REPO_URL = 'http://github.com/skateman/hwping'
+  CONFIG_FILE = 'config.yml'
+end

data/lib/hwping/handler.rb

@@ -0,0 +1,68 @@
+module HWPing
+  class Handler
+    # Set up the handler with the configuration
+    def initialize(launcher, config)
+      @targets    = config.targets
+      @auth       = config.auth
+      @nick       = config.nick
+      @launcher   = launcher
+    end
+
+    # If the event happened in a channel, return just with a symbol
+    def channel(event)
+      if event.message =~ /^hwping,?\s+(.*)\s*$/
+        if @auth.include?(event.user.to_s)
+          if @targets.include?($1)
+            @launcher.point_and_fire(@targets[$1])
+            return :firing
+          else
+            return :notarget
+          end
+        else
+          return :unauthorized
+        end
+      end
+    end
+
+    # If the event happened in a private window, return with an array
+    def private(event)
+      if @auth.include?(event.user.to_s)
+        case event.message
+        when "fire"
+          @launcher.fire
+          return [:fire]
+        when "position"
+          return @launcher.position.unshift(:position)
+        when "help"
+          return [:help]
+        when "reset"
+          @launcher.reset
+          return [:reset]
+        when "target list"
+          return [:target_list, @targets.keys.join(', ')]
+        when /^target set ([^\s]+)( (\d+) (\d+))?$/
+          @targets[$1] = $2 ? [$3.to_i, $4.to_i] : @launcher.position
+          return [:target_set, @targets[$1]].flatten
+        when /^target ((get)|(del)) ([^\s]+)$/
+          if @targets.has_key?($+)
+            if $1 == "del"
+              @targets.delete($+)
+              return [:target_del]
+            else
+              return [:target_get, @targets[$+]].flatten
+            end
+          else
+            return [:notarget]
+          end
+        when /^((up)|(down)|(left)|(right)) (\d+)$/
+          @launcher.send($1, $+.to_i)
+          return [:move]
+        else
+          return [:badcommand]
+        end
+      else
+        return [:unauthorized]
+      end
+    end
+  end
+end

data/lib/hwping/hwping.rb

@@ -0,0 +1,26 @@
+module HWPing
+  class HWPing
+
+    attr_reader :bot
+
+    def initialize(config = {})
+      @config = Config.new(config)
+      @launcher = Launcher.connect()
+      @handler = Handler.new(@launcher, @config)
+      @bot = Bot.new(@handler, @config)
+    end
+
+    def start
+      @bot.start
+    end
+
+    def stop
+      @bot.quit
+    end
+
+    # Return the configuration hash for an export
+    def config
+      @config.to_hash
+    end
+  end
+end

data/lib/hwping/launcher.rb

@@ -0,0 +1,136 @@
+# Inspired by https://github.com/robhurring/thunder/blob/master/lib/launcher.rb
+require 'libusb'
+
+module HWPing
+  class Launcher
+
+    DeviceNotFoundError = Class.new(IOError)
+
+    DEVICE = {
+      :vendor_id  => 0x2123,
+      :product_id => 0x1010
+    }
+
+    COMMANDS = {
+      :down  => 0x01,
+      :up    => 0x02,
+      :left  => 0x04,
+      :right => 0x08,
+      :fire  => 0x10,
+      :stop  => 0x20,
+      :on    => 0x01,
+      :off   => 0x00
+    }
+
+    TARGETS = {
+      :launcher => 0x02,
+      :led      => 0x03
+    }
+
+    REQUEST_TYPE  = 0x21
+    REQUEST       = 0x09
+
+    # Connect to the device
+    def self.connect
+      usb = LIBUSB::Context.new
+      launcher = usb.devices(
+        :idVendor  => DEVICE[:vendor_id],
+        :idProduct => DEVICE[:product_id]
+      ).first
+
+      raise DeviceNotFoundError, 'Launcher was not found.' if launcher.nil?
+      new(launcher)
+    end
+
+    def initialize(device)
+      @device = device
+      @handle = @device.open
+      @handle.detach_kernel_driver(0) if @handle.kernel_driver_active?(0)
+      @x = 0
+      @y = 0
+    end
+
+    # Point at the given location and fire a rocket
+    def point_and_fire(arr)
+      led(:on)
+      reset
+      right arr[0]
+      up arr[1]
+      fire
+      led(:off)
+    end
+
+    # Get the relative position
+    def position
+      [@x, @y]
+    end
+
+    # Switch the LED on/off
+    def led(status)
+      send! :led, status
+    end
+
+    # Fire a rocket and wait for the device to reload
+    def fire
+      send! :launcher, :fire
+      Kernel.sleep 4.5
+    end
+
+    # Resets the launcher into the default position
+    def reset
+      down(1000)
+      left(6000) # should be enough
+      @x = 0
+      @y = 0
+    end
+
+    # Positioning functions
+    [:up, :down, :left, :right].each do |direction|
+      define_method direction do |duration|
+        move direction, duration
+      end
+    end
+
+    # Not really the best motor control
+    def move(direction, duration)
+      send! :launcher, direction
+      Kernel.sleep duration.to_f / 1000
+      send! :launcher, :stop
+      update_pos direction, duration
+    end
+
+  private
+    # Send data through USB
+    def send!(target, command)
+      payload = build_payload(target, COMMANDS[command.to_sym])
+
+      @handle.control_transfer(
+        bmRequestType: REQUEST_TYPE,
+        bRequest: REQUEST,
+        wValue: 0,
+        wIndex: 0,
+        dataOut: payload,
+        timeout: 0
+      )
+    end
+
+    def build_payload(target, command)
+      [TARGETS[target], command, 0, 0, 0, 0, 0, 0].pack('CCCCCCCC')
+    end
+
+    # Update inner position variables
+    def update_pos(direction, value)
+      value = value.to_i
+      case direction
+      when :up
+        @y = [1000, @y + value].min
+      when :down
+        @y = [0, @y - value].max
+      when :right
+        @x = [6000, @x + value].min
+      when :left
+        @x = [0, @x - value].max
+      end
+    end
+  end
+end

data/lib/hwping.rb

@@ -0,0 +1,6 @@
+require 'hwping/constants'
+require 'hwping/config'
+require 'hwping/launcher'
+require 'hwping/handler'
+require 'hwping/bot'
+require 'hwping/hwping'

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: hwping
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dávid Halász
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: libusb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: cinch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: IRC bot for HW pinging with the Dream Cheeky Thunder missile launcher
+email: skateman@skateman.eu
+executables:
+- hwping
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/hwping/handler.rb
+- lib/hwping/launcher.rb
+- lib/hwping/hwping.rb
+- lib/hwping/bot.rb
+- lib/hwping/config.rb
+- lib/hwping/constants.rb
+- lib/hwping.rb
+- bin/hwping
+homepage: http://github.com/skateman/hwping
+licenses:
+- GPL-2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Hardware Pinger
+test_files: []