iremocon_control 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b72b7f828575729e18e3fe9683a1e14859d4dd25
-  data.tar.gz: bd5613515ad8f18ce1f2bdb0265b8a132a4c3ade
+  metadata.gz: 2c0c54f0840128ef6f2daf0a9282379120df398a
+  data.tar.gz: 5914525d2c73291055102a1957675aad40e5ccc9
 SHA512:
-  metadata.gz: 31d4f6dad7d563b58aea0c6898db9d17f67630cc1841984f705279f341b5a4e8d7d7ee393a31647a6d51cb4ac218a82dc69e9a87e50bb29c7950fad4a3bcf07d
-  data.tar.gz: fdcc65784c484624611dab962396dd6f7a95179ede1b6bab79e150e6fc1ab4f3a92ef97065395ac4d60b13974820a0a005a916c9117ccbdfcb1ffdb32807f6a2
+  metadata.gz: 0bd816967a3134bdee5fb2294ea1f94bd489ce0e7d5d571dd839e376b34767fc857eec8bc25cb7ec786f7a9eefee875716ae39ee545aa52ef9ac30fa5d80b221
+  data.tar.gz: 1ae325f37e38824b9befabffc9f3ecae3ec0d5729fc51419d1a884227f0fbf31557a8016750e5f6afaa6276e069d3e79089924173c98e9ef0f9c9679bf2c08b5

data/README.md

@@ -1,6 +1,7 @@
 # IremoconControl
 
-TODO: Write a gem description
+株式会社Glamoから発売されている学習リモコンiRemoconをRubyから操作するgemです。
+赤外線送信、赤外線登録、タイマ登録など一通りの機能があります。
 
 ## Installation
 
@@ -18,7 +19,56 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Ruby上からIRemoconを操作する場合
+モジュールをロードします。
+
+    require 'iremocon_control'
+
+IRemoconオブジェクトを作成します。
+
+    iremocon = IRemoconControl::IRemocon.new '192.168.0.100'
+
+IRemoconオブジェクトに対してコマンドを発行します。
+
+    # リモコンNo.1として登録した赤外線を送信
+    iremocon.is 1
+
+### シェル上からIRemoconを操作する場合
+#### 基本的な使い方
+ホスト名とリモコン番号を指定して赤外線を送信
+
+    $ iremocon -h 192.168.0.100 1
+
+#### 設定ファイルの読み込み
+設定ファイルにiRemoconのホスト名(、ポート番号)を指定することができます。
+設定はYAML形式で指定します。
+
+    $ cat iremoconrc
+    host: 192.168.0.100
+    $ iremocon -f iremoconrc 1
+
+~/.iremoconrcはデフォルトで読み込まれます。
+
+    $ cat ~/.iremoconrc
+    host: 192.168.0.100
+    $ iremocon 1
+
+#### is(赤外線送信)以外のコマンドの利用
+iremoconとの接続の確認
+
+    $ iremocon --au
+
+iremoconの現在時刻設定(引数 : 設定する時刻のUnixTime)
+
+    $ iremocon --ts `date '+%s'`
+
+iremoconの現在時刻取得
+
+    $ iremocon --tg
+
+iremoconのバージョン番号取得
+
+    $ iremocon --vr
 
 ## Contributing
 

data/bin/iremocon

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 #encoding: utf-8
 
-require 'iremocon_control'
+require_relative '../lib/iremocon_control.rb'
 require 'optparse'
 require 'yaml'
 

data/iremocon_control.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["yuta84q.ihcarok@gmail.com"]
   spec.summary       = "send commands to iremocon"
   spec.description   = "send commands to iremocon"
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/84q/iremocon_control"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

data/lib/iremocon_control/iremocon_error.rb

@@ -23,6 +23,22 @@ module IRemoconControl
     def inspect
       "[#{@command}-#{@code}] #{@desctiption}"
     end
+    
+    #
+    # IRemoconからの戻り値がエラーか
+    #
+    def self.error?(reply)
+      reply[1] == "err"
+    end
+    
+    #
+    # IRemoconからのエラーの返す
+    #
+    def self.get_error(reply)
+      cmd = reply[0]
+      err_no = reply[2]
+      return IRemoconError.new cmd, err_no
+    end
   end
 end
 

data/lib/iremocon_control/version.rb

@@ -1,3 +1,3 @@
 module IRemoconControl
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/iremocon_control.rb

@@ -15,6 +15,9 @@ module IRemoconControl
     
     #
     # コンストラクタ
+    # @param [String] host IRemoconのホスト名(またはIPアドレス)
+    # @param [Integer] port IRemoconのポート番号
+    # @param [String,Logger,IO] logger ログの出力先(出力しない場合、nil)
     #
     def initialize(host, port=51013, logger:nil)
       @host = host
@@ -25,6 +28,9 @@ module IRemoconControl
     
     #
     # 接続の確認用コマンド
+    # @return [TrueClass] 常にtrue
+    # @raise [TelnetConnectionError] 通信エラーが発生した場合
+    # @raise [IRemoconError] IRemoconからエラーが帰ってきた場合
     #
     def au
       reply = send_cmd("*au")
@@ -33,6 +39,10 @@ module IRemoconControl
     
     #
     # 赤外線発光用コマンド
+    # @param [Integer] remocon_id 発行するリモコンID
+    # @return [TrueClass] 常にtrue
+    # @raise [TelnetConnectionError] 通信エラーが発生した場合
+    # @raise [IRemoconError] IRemoconからエラーが帰ってきた場合
     #
     def is(remocon_id)
       reply = send_cmd("*is", remocon_id)
@@ -41,6 +51,10 @@ module IRemoconControl
   
     #
     # リモコン学習開始用コマンド
+    # @param [Integer] remocon_id 学習するリモコンID
+    # @return [TrueClass] 常にtrue
+    # @raise [TelnetConnectionError] 通信エラーが発生した場合
+    # @raise [IRemoconError] IRemoconからエラーが帰ってきた場合
     #
     def ic(remocon_id)
       reply = send_cmd("*ic", remocon_id)
@@ -49,6 +63,9 @@ module IRemoconControl
   
     #
     # リモコン学習中止用コマンド
+    # @return [TrueClass] 常にtrue
+    # @raise [TelnetConnectionError] 通信エラーが発生した場合
+    # @raise [IRemoconError] IRemoconからエラーが帰ってきた場合
     #
     def cc
       reply = send_cmd("*cc")
@@ -57,6 +74,12 @@ module IRemoconControl
   
     #
     # タイマーセット用コマンド
+    # @param [Integer] remocon_id タイマーをセットするリモコンID
+    # @param [Time] time 次回の日時
+    # @param [Time] repeat_interval 繰り返し秒数(繰り返さない場合、0)
+    # @return [TrueClass] 常にtrue
+    # @raise [TelnetConnectionError] 通信エラーが発生した場合
+    # @raise [IRemoconError] IRemoconからエラーが帰ってきた場合
     #
     def tm(remocon_id, time, repeat_interval = 0)
       reply = send_cmd("*tm", remocon_id, time.to_i, repeat_interval)
@@ -65,22 +88,33 @@ module IRemoconControl
   
     #
     # タイマー一覧取得用コマンド
+    # @return [Array<IRemoconTimer>] タイマー一覧
+    # @raise [TelnetConnectionError] 通信エラーが発生した場合
+    # @raise [IRemoconError] IRemoconからエラーが帰ってきた場合
     #
     def tl
       reply = send_cmd("*tl")
-      reply[3..-1].map(&:to_i).each_slice(4).to_a
+      reply[3..-1].map(&:to_i).each_slice(4).map {|timer_id, remocon_id, time, repeat_interval|
+        IRemoconTimer.new(timer_id, remocon_id, Time.at(time), repeat_interval);
+      }
     end
   
     #
     # タイマー解除用コマンド
+    # @param [Integer] timer_id 解除するタイマーID
+    # @return [TrueClass] 常にtrue
+    # @raise [TelnetConnectionError] 通信エラーが発生した場合
+    # @raise [IRemoconError] IRemoconからエラーが帰ってきた場合
     #
     def td(timer_id)
       reply = send_cmd("*td", timer_id)
       true
     end
-  
+    
     #
     # 現在時刻設定用コマンド
+    # @param [Integer] time 現在時刻
+    # @return [TrueClass] 常にtrue
     #
     def ts(time)
       reply = send_cmd("*ts", time.to_i)
@@ -89,14 +123,20 @@ module IRemoconControl
   
     #
     # 現在時刻取得用コマンド
+    # @return [Time] 現在時刻
+    # @raise [TelnetConnectionError] 通信エラーが発生した場合
+    # @raise [IRemoconError] IRemoconからエラーが帰ってきた場合
     #
     def tg
       reply = send_cmd("*tg")
-      reply[2].to_i
+      Time.at(reply[2].to_i)
     end
   
     #
     # ファームバージョン番号の取得用コマンド
+    # @return [String] バージョン番号
+    # @raise [TelnetConnectionError] 通信エラーが発生した場合
+    # @raise [IRemoconError] IRemoconからエラーが帰ってきた場合
     #
     def vr
       reply = send_cmd("*vr")
@@ -109,12 +149,12 @@ module IRemoconControl
       begin
         reply = _send_cmd(*cmds)
       rescue => e
-        @logger.warn "#{cmds} -> #{e}"
+        @logger.error "#{cmds} -> #{e}"
         raise e
       end
       
-      if error? reply
-        error = get_error reply
+      if IRemoconError.error? reply
+        error = IRemoconError.get_error reply
         @logger.warn "#{cmds} -> #{error}"
         raise error
       else
@@ -126,29 +166,35 @@ module IRemoconControl
     def _send_cmd(*cmds)
       begin
         telnet = Net::Telnet.new('Host' => @host, 'Port' => @port)
+        
+        code = ""
+        telnet.cmd(cmds.join(";")) do |res|
+          code << res;
+          break if res =~ /\n$/
+        end
+        
+        telnet.close
       rescue
-        raise StandardError.new("IRemocon Connection Error - #{@host}:#{port}")
+        raise TelnetConnectionError.new("IRemocon Connection Error - #{@host}:#{@port}")
       end
-      
-      code = ""
-      telnet.cmd(cmds.join(";")) do |res|
-        code << res;
-        break if res =~ /\n$/
-      end
-      
-      telnet.close
       return code.chomp.split(";")
     end
+  end
+  
+  class TelnetConnectionError < StandardError; end
+  
+  class IRemoconTimer
+    attr_reader :timer_id, :remocon_id, :time, :repeat_interval
     
-    def error?(reply)
-      reply[1] == "err"
+    def initialize(timer_id, remocon_id, time, repeat_interval)
+      @timer_id, @remocon_id, @time, @repeat_interval = timer_id, remocon_id, Time.at(time), repeat_interval;
     end
     
-    def get_error(reply)
-      cmd = reply[0]
-      err_no = reply[2]
-      return IRemoconError.new cmd, err_no
+    def to_s
+      "remocon_id : #{@remocon_id}, next : #{@time}, repeat : #{@repeat_interval}"
     end
+    
+    alias_method :inspect, :to_s
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iremocon_control
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - YutaTanaka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-05 00:00:00.000000000 Z
+date: 2014-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,7 +75,7 @@ files:
 - lib/iremocon_control/version.rb
 - spec/iremocon_control_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/84q/iremocon_control
 licenses:
 - MIT
 metadata: {}
@@ -100,3 +100,4 @@ signing_key:
 specification_version: 4
 summary: send commands to iremocon
 test_files: []
+has_rdoc: