hacky_hal 0.2.0

data/.gitignore

@@ -0,0 +1,3 @@
+/Gemfile.lock
+.DS_Store
+**.orig

data/Gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "upnp-nickewing"
+gem "net-ssh"
+gem "serialport"
+
+group :test do
+  gem "rspec"
+  gem "rspec-mocks"
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (C) 2013 by Nick Ewing
+
+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.markdown

@@ -0,0 +1,57 @@
+![HackyHal](https://raw.github.com/nickewing/hacky_hal/master/support/hal-9000-small.png) HackyHAL
+========
+
+What is it?
+-----------
+
+HackyHAL (Hacky Home Automation Library) is in its current form is a small
+Ruby library meant to control devices through the network or serial ports.
+The number of supported devices is currently very limited, however hopefully
+the library will grow to support more devices over time.
+
+Who is this for?
+----------------
+This project is for anyone wishing to write their own custom home automation
+software/scripts.  It is not user friendly and does not have any form of
+built-in UI.
+
+What devices are supported?
+---------------------------
+Supported functionality varies greatly with each device.
+
+* **Epson Projector** (via serial port.  Tested on HC8350, though likely also
+  works with other models)
+* **Yamaha AV Receiver** (via network.  Tested on RX-A1020.  Should work with
+  RX-A2020 and RX-A3020 as well)
+* **Roku** (via network)
+* **Iogear AVIOR HDMI Switch** (via serial port. 8x1 GHSW8181 or 4x1 GHSW8141)
+* **SSH accessible computer**
+
+How can I use it?
+-------------------
+HackyHAL is simply a library to be used however you want.
+
+You'll likely want to run a server utilizing HackyHAL on a networked computer (a
+Raspberry Pi works great).
+You'd then attach any serial port devices to that computer.  You could then
+create a mobile app to control the server.  See the examples directory.
+
+Can I contribue?
+----------------
+Please do!  It would be great to see this library grow to support many more
+devices.  Just fork, make your changes, and send a pull request.  Please be sure
+to write tests for contributions.
+
+Contributors
+------------
+* Nick Ewing
+
+Special thanks to [Mischa McLachlan](https://www.iconfinder.com/icons/27626/9000_hal_light_red_space_icon) for the HAL 9000 icon.
+
+License and Copyright
+---------------------
+
+HackyHAL is distributed under the MIT License.  See LICENSE.
+
+Copyright © 2013 Nick Ewing
+

data/hacky_hal.gemspec

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+Gem::Specification.new do |gem|
+  gem.name    = "hacky_hal"
+  gem.version = "0.2.0"
+
+  gem.authors     = ["Nick Ewing"]
+  gem.email       = ["nick@nickewing.net"]
+  gem.description = "HackyHAL - Hacky Home Automation Library"
+  gem.summary     = gem.description
+  gem.homepage    = ""
+
+  gem.add_dependency("upnp-nickewing", "~> 0.1.0")
+  gem.add_dependency("serialport", "~> 1.1.0")
+  gem.add_dependency("net-ssh", "~> 2.6.0")
+
+  gem.files         = `git ls-files`.split($\)
+  gem.test_files    = gem.files.grep(/^spec/)
+  gem.require_paths = ["lib"]
+end

data/lib/hacky_hal/device_controllers/base.rb

@@ -0,0 +1,14 @@
+require_relative "../log"
+require_relative "../options"
+
+module HackyHAL
+  module DeviceControllers
+    class Base
+      include Options
+
+      def log(message, level = :info)
+        Log.instance.send(level, "#{options[:name]}: #{message}")
+      end
+    end
+  end
+end

data/lib/hacky_hal/device_controllers/epson_projector.rb

@@ -0,0 +1,180 @@
+require_relative "generic_serial_port"
+
+module HackyHAL
+  module DeviceControllers
+    class EpsonProjector < GenericSerialPort
+
+      SERIAL_PORT_OPTIONS = {
+        baud_rate: 9600,
+        data_bits: 8,
+        stop_bits: 1,
+        parity: SerialPort::NONE,
+        flow_control: SerialPort::NONE
+      }
+
+      SOURCE_COMMAND_TIMEOUT = 5
+
+      POWER_STATUS_TO_SYMBOL = {
+        "00" => :standby, # standby, network off
+        "01" => :on,
+        "02" => :warming_up,
+        "03" => :cooling_down,
+        "04" => :standby, # standby, network on
+        "05" => :standby # standby, abnormal
+      }
+
+      DEVICE_SOURCE_ID_TO_NAME = {
+        "HC8350" => {
+          "30" => "HDMI1",
+          "A0" => "HDMI2",
+          "14" => "Component (YCbCr)",
+          "15" => "Component (YPbPr)",
+          "21" => "PC",
+          "41" => "Video (RCA)",
+          "42" => "S-Video"
+        }
+      }
+
+      DEVICE_CMODE_ID_TO_NAME = {
+        "HC8350" => {
+          "06" => "Dynamic",
+          "0C" => "Living Room",
+          "07" => "Natural",
+          "15" => "Cinema",
+          "0B" => "x.v.Color"
+        }
+      }
+
+      DEVICE_ASPECT_RATIO_ID_TO_NAME = {
+        "HC8350" => {
+          "00" => "Normal"
+        }
+      }
+
+      ERROR_CODE_TO_MESSAGE = {
+        "00" => "There is no error or the error is recovered",
+        "01" => "Fan error",
+        "03" => "Lamp failure at power on",
+        "04" => "High internal temperature error",
+        "06" => "Lamp error",
+        "07" => "Open Lamp cover door error",
+        "08" => "Cinema filter error",
+        "09" => "Electric dual-layered capacitor is disconnected",
+        "0A" => "Auto iris error",
+        "0B" => "Subsystem Error",
+        "0C" => "Low air flow error",
+        "0D" => "Air filter air flow sensor error",
+        "0E" => "Power supply unit error (Ballast)",
+        "0F" => "Shutter error",
+        "10" => "Cooling system error (peltiert element)",
+        "11" => "Cooling system error (Pump)"
+      }
+
+      attr_reader :model
+
+      def initialize(options = {})
+        options[:serial_options] = SERIAL_PORT_OPTIONS
+        super(options)
+        @model = options[:model]
+      end
+
+      def on
+        power_status == :on
+      end
+
+      def on=(value)
+        value = value ? "ON" : "OFF"
+        write_command("PWR #{value}")
+        read_command(1)
+      end
+
+      def power_status
+        write_command("PWR?")
+        status_code = get_command_output(read_command)
+        POWER_STATUS_TO_SYMBOL[status_code] || :unknown
+      end
+
+      def lamp_hours
+        write_command("LAMP?")
+        get_command_output(read_command).to_i
+      end
+
+      def source
+        write_command("SOURCE?")
+        source_id = get_command_output(read_command)
+
+        source_name_hash = DEVICE_SOURCE_ID_TO_NAME[model]
+        source_name = source_name_hash[source_id] || "Unknown"
+
+        {id: source_id, name: source_name}
+      end
+
+      def source=(source_id)
+        write_command("SOURCE #{source_id}")
+        read_command(SOURCE_COMMAND_TIMEOUT)
+      end
+
+      def color_mode
+        write_command("CMODE?")
+        color_mode_id = get_command_output(read_command)
+
+        color_mode_hash = DEVICE_CMODE_ID_TO_NAME[model]
+        color_mode_name = color_mode_hash[color_mode_id] || "Unknown"
+
+        {id: color_mode_id, name: color_mode_name}
+      end
+
+      def color_mode=(color_mode_id)
+        write_command("CMODE #{color_mode_id}")
+        read_command
+      end
+
+      def aspect_ratio
+        write_command("ASPECT?")
+        aspect_ratio_id = get_command_output(read_command)
+        
+        aspect_ratio_hash = DEVICE_ASPECT_RATIO_ID_TO_NAME[model]
+        aspect_ratio_name = aspect_ratio_hash[aspect_ratio_id] || "Unknown"
+
+        {id: aspect_ratio_id, name: aspect_ratio_name}
+      end
+
+      def aspect_ratio=(aspect_ratio_id)
+        write_command("ASPECT #{aspect_ratio_id}")
+        read_command
+      end
+
+      def error
+        write_command("ERR?")
+        set_read_timeout(DEFAULT_COMMAND_TIMEOUT)
+        error_code = get_command_output(read_line)
+        if error_code
+          error_message = ERROR_CODE_TO_MESSAGE[error_code] || "Unknown"
+          {code: error_code, message: error_message}
+        end
+      end
+
+      private
+
+      # overrides GenericSerialPort#error_response?
+      def error_response?(response)
+        response =~ /^:?ERR/
+      end
+
+      def handle_error
+        error_details = error
+
+        if error_details
+          raise CommandError, "Projector returned error code #{error_details[:code]}: #{error_details[:message]}."
+        else
+          raise CommandError, "Projector returned an error."
+        end
+      end
+
+      def get_command_output(output)
+        output =~ /^:?\w+=(.+)\r:$/
+        $1 ? $1.chomp : nil
+      end
+    end
+  end
+end

data/lib/hacky_hal/device_controllers/generic_serial_port.rb

@@ -0,0 +1,108 @@
+require "serialport"
+require_relative "base"
+
+module HackyHAL
+  module DeviceControllers
+    class GenericSerialPort < Base
+      MAX_READ_WRITE_RETRIES = 1
+
+      DEFAULT_COMMAND_TIMEOUT = 3
+
+      DEFAULT_OPTIONS = {
+        baud_rate: 9600,
+        data_bits: 8,
+        stop_bits: 1,
+        parity: SerialPort::NONE,
+        flow_control: SerialPort::NONE
+      }
+
+      class CommandError < Exception; end
+
+      attr_reader :serial_device_path, :serial_options
+
+      def initialize(options = {})
+        super(options)
+        ensure_option(:serial_device_path)
+
+        @serial_device_path = options[:serial_device_path]
+        @serial_options = DEFAULT_OPTIONS.merge(options[:serial_options] || {})
+      end
+
+      def write_command(command)
+        read_write_retry do
+          serial_port.flush
+          command = "#{command}\r\n"
+          log("Wrote: #{command.inspect}", :debug)
+          serial_port.write(command)
+          true
+        end
+      end
+
+      def read_command(timeout = DEFAULT_COMMAND_TIMEOUT)
+        set_read_timeout(timeout) if timeout
+
+        begin
+          output = read_line
+          log("Read: #{output.inspect}", :debug)
+          handle_error if error_response?(output)
+          output
+        rescue EOFError
+          log("Read EOFError", :warn)
+          nil
+        end
+      end
+
+      def disconnect
+        @serial_port.close if @serial_port
+        @serial_port = nil
+      end
+
+      def serial_port
+        @serial_port ||= SerialPort.new(serial_device_path).tap do |s|
+          s.baud = serial_options[:baud_rate]
+          s.data_bits = serial_options[:data_bits]
+          s.stop_bits = serial_options[:stop_bits]
+          s.parity = serial_options[:parity]
+          s.flow_control = serial_options[:flow_control]
+        end
+      end
+
+      protected
+
+      def read_write_retry
+        retries = 0
+
+        begin
+          yield
+        rescue Errno::EIO => e
+          if retries < MAX_READ_WRITE_RETRIES
+            retries += 1
+            disconnect
+            retry
+          else
+            raise e
+          end
+        end
+      end
+
+      def handle_error
+        raise CommandError, "Serial device returned an error."
+      end
+
+      def set_read_timeout(timeout)
+        serial_port.read_timeout = timeout * 1000
+      end
+
+      def read_line
+        read_write_retry do
+          serial_port.readline
+        end
+      end
+
+      def error_response?(response)
+        false
+      end
+
+    end
+  end
+end

data/lib/hacky_hal/device_controllers/generic_ssh.rb

@@ -0,0 +1,74 @@
+require 'net/ssh'
+require_relative "base"
+
+module HackyHAL
+  module DeviceControllers
+    class GenericSsh < Base
+      MAX_COMMAND_RETRIES = 1
+
+      attr_reader :host, :user, :ssh_options
+
+      def initialize(options)
+        super(options)
+
+        ensure_option(:host)
+        ensure_option(:user)
+
+        @host = options[:host]
+        @user = options[:user]
+        @ssh_options = options[:ssh_options] || {}
+      end
+
+      def exec(command)
+        out = nil
+        retries = 0
+
+        begin
+          connect unless connected?
+          log("Command: #{command.inspect}", :debug)
+          out = ssh_exec(command)
+          log("Output: #{out.inspect}", :debug)
+        rescue Net::SSH::Disconnect, EOFError  => e
+          log("Command failed: #{e.class.name} - #{e.message}", :warn)
+          disconnect
+
+          if retries < MAX_COMMAND_RETRIES
+            log("Retrying last command", :warn)
+            retries += 1
+            retry
+          end
+        end
+
+        out
+      end
+
+      def connect
+        disconnect if @ssh
+        @ssh = Net::SSH.start(host, user, ssh_options)
+      rescue SocketError, Net::SSH::Exception, Errno::EHOSTUNREACH => e
+        log("Failed to connect: #{e.class.name} - #{e.message}", :warn)
+      end
+
+      def connected?
+        @ssh && !@ssh.closed?
+      end
+
+      def disconnect
+        @ssh.close if connected?
+      rescue Net::SSH::Disconnect
+      ensure
+        @ssh = nil
+      end
+
+      private
+
+      def ssh_exec(command)
+        out = []
+        @ssh.exec!(command) do |channel, stream, data|
+          out << data
+        end
+        out.join("")
+      end
+    end
+  end
+end

data/lib/hacky_hal/device_controllers/io_gear_avior_hdmi_switch.rb

@@ -0,0 +1,58 @@
+require_relative "generic_serial_port"
+
+module HackyHAL
+  module DeviceControllers
+    class IoGearAviorHdmiSwitch < GenericSerialPort
+
+      SERIAL_PORT_OPTIONS = {
+        baud_rate: 19200,
+        data_bits: 8,
+        stop_bits: 1,
+        parity: SerialPort::NONE,
+        flow_control: SerialPort::NONE
+      }
+
+      def initialize(options = {})
+        options[:serial_options] = SERIAL_PORT_OPTIONS
+        super(options)
+      end
+
+      def input=(value)
+        unless value.is_a?(Fixnum)
+          raise ArgumentError, "Input value must be an integer."
+        end
+
+        unless value > 0
+          raise ArgumentError, "Input value must be positive."
+        end
+
+        value = value.to_s.rjust(2, "0")
+        write_command("sw i#{value}")
+        read_command
+      end
+
+      def switch_to_next_input
+        write_command("sw +")
+        read_command
+      end
+
+      def switch_to_previous_input
+        write_command("sw -")
+        read_command
+      end
+
+      def power_on_detection=(value)
+        value = value ? "on" : "off"
+        write_command("pod #{value}")
+        read_command
+      end
+
+      private
+
+      # overrides GenericSerialPort#error_response?
+      def error_response?(response)
+        response =~ /Command incorrect/
+      end
+    end
+  end
+end

data/lib/hacky_hal/device_controllers/linux_computer.rb

@@ -0,0 +1,36 @@
+require_relative "generic_ssh"
+
+module HackyHAL
+  module DeviceControllers
+    class LinuxComputer < GenericSsh
+      def mirror_screens(source_screen, dest_screen)
+        xrandr_command("--output #{dest_screen} --same-as #{source_screen}")
+      end
+
+      def set_screen_position(screen_1, screen_2, position)
+        xrandr_command("--output #{screen_1} --#{position}-of #{screen_2}")
+      end
+
+      def reset_display_settings(screen)
+        xrandr_command("--output #{screen} --auto")
+      end
+
+      private
+
+      def xrandr_command(options)
+        x_env_variables = [
+          "CONSOLE=$(sudo fgconsole)",
+          "SESSION=$(who -s | grep tty$CONSOLE | tr '()' ' ')",
+          "XUSER=$(echo $SESSION | awk '{print $1}')",
+          "DISPLAY=$(echo $SESSION | awk '{print $5}')",
+          "XAUTHORITY=/home/$XUSER/.Xauthority",
+          "export DISPLAY",
+          "export XAUTHORITY"
+        ].join("; ")
+
+        command = "#{x_env_variables}; xrandr -d $DISPLAY #{options}"
+        exec(command)
+      end
+    end
+  end
+end

data/lib/hacky_hal/device_controllers/osx_computer.rb

@@ -0,0 +1,19 @@
+require_relative "generic_ssh"
+
+module HackyHAL
+  module DeviceControllers
+    class OsxComputer < GenericSsh
+      def mirror_screens
+        exec("mirror -on")
+      end
+
+      def unmirror_screens
+        exec("mirror -off")
+      end
+
+      def set_audio_output_device(name)
+        exec("audiodevice output '#{name}'")
+      end
+    end
+  end
+end