pj_link 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aec09d81bcdea4646f9990366f1888025d995798
+  data.tar.gz: 097dfeaa7039e099bb58e604aaaee09e5208ab02
+SHA512:
+  metadata.gz: 78e73f0b3b90a10252254a0a6a0ed52488c047a8259603dff64d19d8cca67f8904527d5bf35ea8aa12950c907ad6f7c7447f97040a41863296da5b9fe5906e81
+  data.tar.gz: a898627e00ba60a726bc33ed90cd5f5b758af72621623e93073a309b5c15d24859c5b1971f0c07096972a61483b3c932c833067375eb0b626bc35ecf5dca0260

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pjlink.gemspec
+gemspec
+
+
+group [:development, :test] do
+  gem 'rspec'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Brian Goff
+
+MIT License
+
+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,57 @@
+# PjLink
+
+A simple library for communicating over the PJLink protocol
+
+Based off of initial work by @macprince:
+https://github.com/macprince/ruby-pjlink
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'pj_link'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pj_link
+
+## Usage
+
+```ruby
+projector = PjLink::Client.new '1.1.1.1', 'super_secret_password'
+projector.power_status
+```
+
+You can also use this without a password if your projector allows you too.
+
+Available commands are:
+ - power_on
+ - power_off
+ - power_status
+ - video_mute_on
+ - video_mute_off
+ - mute_on
+ - mute_off
+ - av_mute_on
+ - av_mute_off
+ - inputs
+ - set_input
+ - mute_status
+ - lamp_hours
+ - device_name
+ - manufacturer
+ - product
+ - pjlink_class
+ - other_info
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/pj_link.rb

@@ -0,0 +1,6 @@
+require "pj_link/version"
+require 'pj_link/client'
+
+
+module PjLink
+end

data/lib/pj_link/client.rb

@@ -0,0 +1,160 @@
+require 'net/telnet'
+require 'digest/md5'
+
+module PjLink
+  class Client
+    attr_accessor :gateway, :password
+
+    def initialize(address, password=nil)
+      @gateway = Gateway.new(*address.split(':'))
+      @password = password
+    end
+
+    def command(cmd)
+      gateway.send_message(cmd, @password)
+    end
+
+    def power_on
+      command 'POWR 1'
+    end
+
+    def power_off
+      command 'POWR 0'
+    end
+
+    def power_status
+      command('POWR ?').to_i
+    end
+
+    def video_mute_on
+      command 'AVMT 11'
+    end
+
+    def video_mute_off
+      command 'AVMT 10'
+    end
+
+    def mute_on
+      command 'AVMT 21'
+    end
+
+    def mute_off
+      command 'AVMT 20'
+    end
+
+    def av_mute_on
+      command 'AVMT 31'
+    end
+
+    def av_mute_off
+      command 'AVMT 30'
+    end
+
+    def inputs
+      command('INST ?').split.sort
+    end
+
+    def set_input(input)
+      command "INPT #{input}"
+    end
+
+    def mute_status
+      command('AVMT ?').to_i
+    end
+
+    def lamp_hours
+      command('LAMP ?').split.map(&:to_i)
+    end
+
+    def device_name
+      command 'NAME ?'
+    end
+
+    def manufacturer
+      command 'INF1 ?'
+    end
+
+    def product
+      command 'INF2 ?'
+    end
+
+    def pjlink_class
+      command 'CLSS ?'
+    end
+
+    def other_info
+      command 'INFO ?'
+    end
+
+    class Gateway
+      class ::PjLink::Client::PasswordRequiredError < StandardError; end
+      DEFAULT_PORT = 4352
+
+      attr_reader :connection, :connection_key, :port, :address
+
+      def initialize(address, port=DEFAULT_PORT)
+        @address, @port = address, port.to_i
+      end
+
+      def send_message(message, password)
+        retry_count = 0
+        begin
+          connect(password)
+          @connection.write("#{@password_hash}%1#{message}\r")
+          response = @connection.waitfor("Prompt" => /%1/).
+            gsub(/^.*=/, "")
+
+          response
+        rescue Errno::EPIPE
+          if retry_count < 4
+            disconnect
+            retry_count += 1
+            retry
+          else
+            raise
+          end
+        rescue Net::ReadTimeout
+          raise PasswordRequiredError,
+            "You must provide a password to access this device"
+        ensure
+          disconnect
+        end
+      end
+    private
+      def connect(password)
+        retry_count = 0
+        begin
+          @connection = Net::Telnet.new(
+            'Host' => @address,
+            'Port' => @port,
+            'Telnetmode' => false,
+            'Promp' => /%1/)
+          _, auth_required, key = *@connection.sock.recvmsg[0].split
+        rescue Errno::ECONNRESET
+          if retry_count < 4
+            retry_count += 1
+            sleep 1
+            retry
+          else
+            raise
+          end
+        end
+
+        @password_hash = Digest::MD5.hexdigest("#{key}#{password}") if auth_required
+        self
+      end
+
+      def disconnect
+        begin
+          @connection.close if @connection
+        rescue IOError; nil
+        ensure
+          @connection = nil
+        end
+      end
+
+    end
+
+  end
+end
+

data/lib/pj_link/version.rb

@@ -0,0 +1,3 @@
+module PjLink
+  VERSION = "1.0.0"
+end

data/pj_link.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pj_link/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pj_link"
+  spec.version       = PjLink::VERSION
+  spec.authors       = ["Brian Goff"]
+  spec.email         = ["cpuguy83@gmail.com"]
+  spec.description   = %q{A simple library for communicating over the PjLink protocol}
+  spec.summary       = %q{A simple library for communicating over the PjLink protocol}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/spec/client.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+module PjLink
+  describe Client do
+    context 'a port is provided' do
+      it 'accepts ADDRESS:PORT notation' do
+        client = Client.new('0.0.0.0:1000')
+
+        expect(client.gateway.port).to eq 1000
+      end
+    end
+
+    context 'no port is provided' do
+      describe Client::Gateway do
+        it 'assigns a default port when no port is given' do
+          gateway = Client::Gateway.new '0.0.0.0'
+
+          expect(gateway.port).
+            to eq Client::Gateway::DEFAULT_PORT
+        end
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'pj_link'

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: pj_link
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brian Goff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple library for communicating over the PjLink protocol
+email:
+- cpuguy83@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pj_link.rb
+- lib/pj_link/client.rb
+- lib/pj_link/version.rb
+- pj_link.gemspec
+- spec/client.rb
+- spec/spec_helper.rb
+homepage: ''
+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.0.6
+signing_key: 
+specification_version: 4
+summary: A simple library for communicating over the PjLink protocol
+test_files:
+- spec/client.rb
+- spec/spec_helper.rb