hidapi 0.1.4

data/lib/hidapi/engine.rb

@@ -0,0 +1,151 @@
+
+module HIDAPI
+
+  ##
+  # A wrapper around the USB context that makes it easy to locate HID devices.
+  class Engine
+
+    ##
+    # Contains the class code for HID devices from LIBUSB.
+    HID_CLASS = LIBUSB::CLASS_HID
+
+    ##
+    # Creates a new engine.
+    def initialize
+      @context = LIBUSB::Context.new
+    end
+
+
+    ##
+    # Enumerates the HID devices matching the vendor and product IDs.
+    #
+    # Both vendor_id and product_id are optional.  They will act as a wild card if set to 0 (the default).
+    def enumerate(vendor_id = 0, product_id = 0, options = {})
+      raise HIDAPI::HidApiError, 'not initialized' unless @context
+
+      if options.is_a?(String) || options.is_a?(Symbol)
+        options = { as: options }
+      end
+
+      unless options.nil? || options.is_a?(Hash)
+        raise ArgumentError, 'options hash is invalid'
+      end
+
+      klass = (options || {}).delete(:as) || 'HIDAPI::Device'
+      klass = Object.const_get(klass) unless klass == :no_mapping
+
+      filters = { bClass: HID_CLASS }
+
+      unless vendor_id.nil? || vendor_id.to_i == 0
+        filters[:idVendor] = vendor_id.to_i
+      end
+      unless product_id.nil? || product_id.to_i == 0
+        filters[:idProduct] = product_id.to_i
+      end
+
+      list = @context.devices(filters)
+
+      if klass != :no_mapping
+        list.to_a.map{ |dev| klass.new(dev) }
+      else
+        list.to_a
+      end
+    end
+
+    ##
+    # Gets the first device with the specified vendor_id, product_id, and optionally serial_number.
+    def get_device(vendor_id, product_id, serial_number = nil, options = {})
+      raise ArgumentError, 'vendor_id must be provided' if vendor_id.to_i == 0
+      raise ArgumentError, 'product_id must be provided' if product_id.to_i == 0
+
+      klass = (options || {}).delete(:as) || 'HIDAPI::Device'
+      klass = Object.const_get(klass) unless klass == :no_mapping
+
+      list = enumerate(vendor_id, product_id, as: :no_mapping)
+      return nil unless list && list.count > 0
+      if serial_number.to_s == ''
+        if klass != :no_mapping
+          return klass.new(list.first)
+        else
+          return list.first
+        end
+      end
+      list.each do |dev|
+        if dev.serial_number == serial_number
+          if klass != :no_mapping
+            return klass.new(dev)
+          else
+            return dev
+          end
+        end
+      end
+      nil
+    end
+
+    ##
+    # Opens the first device with the specified vendor_id, product_id, and optionally serial_number.
+    def open(vendor_id, product_id, serial_number = nil)
+      dev = get_device(vendor_id, product_id, serial_number)
+      dev.open if dev
+    end
+
+    ##
+    # Gets the device with the specified path.
+    def get_device_by_path(path, options = {})
+      klass = (options || {}).delete(:as) || 'HIDAPI::Device'
+      klass = Object.const_get(klass) unless klass == :no_mapping
+
+      enumerate(as: :no_mapping).each do |usb_dev|
+        usb_dev.settings.each do |intf_desc|
+          if intf_desc.bInterfaceClass == HID_CLASS
+            dev_path = HIDAPI::make_path(usb_dev, intf_desc.bInterfaceNumber)
+            if dev_path == path
+              if klass != :no_mapping
+                return klass.new(usb_dev, intf_desc.bInterfaceNumber)
+              else
+                return usb_dev
+              end
+            end
+          end
+        end
+      end
+    end
+
+    ##
+    # Opens the device with the specified path.
+    def open_path(path)
+      dev = get_device_by_path(path)
+      dev.open if dev
+    end
+
+    ##
+    # Gets the USB code for the current locale.
+    def usb_code_for_current_locale
+      @usb_code_for_current_locale ||=
+          begin
+            locale = I18n.locale
+            if locale
+              locale = locale.to_s.partition('.')[0]  # remove encoding
+              result = HIDAPI::Language.get_by_code(locale)
+              unless result
+                locale = locale.partition('_')[0]     # chop off extra specification
+                result = HIDAPI::Language.get_by_code(locale)
+              end
+              result ? result[:usb_code] : 0
+            else
+              0
+            end
+          end
+    end
+
+
+    def inspect   # :nodoc:
+      "#<#{self.class.name}:#{self.object_id.to_hex(16)} context=0x#{@context.object_id.to_hex(16)}>"
+    end
+
+    def to_s      # :nodoc:
+      inspect
+    end
+
+  end
+end

data/lib/hidapi/errors.rb

@@ -0,0 +1,18 @@
+module HIDAPI
+
+  ##
+  # A general error from the HIDAPI library.
+  HidApiError = Class.new(StandardError)
+
+  ##
+  # The device supplied was invalid for the HIDAPI::Device class.
+  InvalidDevice = Class.new(HidApiError)
+
+  ##
+  # Failed to open a device.
+  DeviceOpenFailed = Class.new(HidApiError)
+
+  ##
+  # An open device is required for the method called.
+  DeviceNotOpen = Class.new(HidApiError)
+end

data/lib/hidapi/language.rb

@@ -0,0 +1,221 @@
+module HIDAPI
+  ##
+  # List of all known USB languages.
+  class Language
+
+    KNOWN = {
+        AFRIKAANS:                      {name: "Afrikaans", code: "af", usb_code: 0x0436},
+        ALBANIAN:                       {name: "Albanian", code: "sq", usb_code: 0x041c},
+        ARABIC___UNITED_ARAB_EMIRATES:  {name: "Arabic - United Arab Emirates", code: "ar_ae", usb_code: 0x3801},
+        ARABIC___BAHRAIN:               {name: "Arabic - Bahrain", code: "ar_bh", usb_code: 0x3c01},
+        ARABIC___ALGERIA:               {name: "Arabic - Algeria", code: "ar_dz", usb_code: 0x1401},
+        ARABIC___EGYPT:                 {name: "Arabic - Egypt", code: "ar_eg", usb_code: 0x0c01},
+        ARABIC___IRAQ:                  {name: "Arabic - Iraq", code: "ar_iq", usb_code: 0x0801},
+        ARABIC___JORDAN:                {name: "Arabic - Jordan", code: "ar_jo", usb_code: 0x2c01},
+        ARABIC___KUWAIT:                {name: "Arabic - Kuwait", code: "ar_kw", usb_code: 0x3401},
+        ARABIC___LEBANON:               {name: "Arabic - Lebanon", code: "ar_lb", usb_code: 0x3001},
+        ARABIC___LIBYA:                 {name: "Arabic - Libya", code: "ar_ly", usb_code: 0x1001},
+        ARABIC___MOROCCO:               {name: "Arabic - Morocco", code: "ar_ma", usb_code: 0x1801},
+        ARABIC___OMAN:                  {name: "Arabic - Oman", code: "ar_om", usb_code: 0x2001},
+        ARABIC___QATAR:                 {name: "Arabic - Qatar", code: "ar_qa", usb_code: 0x4001},
+        ARABIC___SAUDI_ARABIA:          {name: "Arabic - Saudi Arabia", code: "ar_sa", usb_code: 0x0401},
+        ARABIC___SYRIA:                 {name: "Arabic - Syria", code: "ar_sy", usb_code: 0x2801},
+        ARABIC___TUNISIA:               {name: "Arabic - Tunisia", code: "ar_tn", usb_code: 0x1c01},
+        ARABIC___YEMEN:                 {name: "Arabic - Yemen", code: "ar_ye", usb_code: 0x2401},
+        ARMENIAN:                       {name: "Armenian", code: "hy", usb_code: 0x042b},
+        AZERI___LATIN:                  {name: "Azeri - Latin", code: "az_az", usb_code: 0x042c},
+        AZERI___CYRILLIC:               {name: "Azeri - Cyrillic", code: "az_az", usb_code: 0x082c},
+        BASQUE:                         {name: "Basque", code: "eu", usb_code: 0x042d},
+        BELARUSIAN:                     {name: "Belarusian", code: "be", usb_code: 0x0423},
+        BULGARIAN:                      {name: "Bulgarian", code: "bg", usb_code: 0x0402},
+        CATALAN:                        {name: "Catalan", code: "ca", usb_code: 0x0403},
+        CHINESE___CHINA:                {name: "Chinese - China", code: "zh_cn", usb_code: 0x0804},
+        CHINESE___HONG_KONG_SAR:        {name: "Chinese - Hong Kong SAR", code: "zh_hk", usb_code: 0x0c04},
+        CHINESE___MACAU_SAR:            {name: "Chinese - Macau SAR", code: "zh_mo", usb_code: 0x1404},
+        CHINESE___SINGAPORE:            {name: "Chinese - Singapore", code: "zh_sg", usb_code: 0x1004},
+        CHINESE___TAIWAN:               {name: "Chinese - Taiwan", code: "zh_tw", usb_code: 0x0404},
+        CROATIAN:                       {name: "Croatian", code: "hr", usb_code: 0x041a},
+        CZECH:                          {name: "Czech", code: "cs", usb_code: 0x0405},
+        DANISH:                         {name: "Danish", code: "da", usb_code: 0x0406},
+        DUTCH___NETHERLANDS:            {name: "Dutch - Netherlands", code: "nl_nl", usb_code: 0x0413},
+        DUTCH___BELGIUM:                {name: "Dutch - Belgium", code: "nl_be", usb_code: 0x0813},
+        ENGLISH___AUSTRALIA:            {name: "English - Australia", code: "en_au", usb_code: 0x0c09},
+        ENGLISH___BELIZE:               {name: "English - Belize", code: "en_bz", usb_code: 0x2809},
+        ENGLISH___CANADA:               {name: "English - Canada", code: "en_ca", usb_code: 0x1009},
+        ENGLISH___CARIBBEAN:            {name: "English - Caribbean", code: "en_cb", usb_code: 0x2409},
+        ENGLISH___IRELAND:              {name: "English - Ireland", code: "en_ie", usb_code: 0x1809},
+        ENGLISH___JAMAICA:              {name: "English - Jamaica", code: "en_jm", usb_code: 0x2009},
+        ENGLISH___NEW_ZEALAND:          {name: "English - New Zealand", code: "en_nz", usb_code: 0x1409},
+        ENGLISH___PHILLIPPINES:         {name: "English - Phillippines", code: "en_ph", usb_code: 0x3409},
+        ENGLISH___SOUTHERN_AFRICA:      {name: "English - Southern Africa", code: "en_za", usb_code: 0x1c09},
+        ENGLISH___TRINIDAD:             {name: "English - Trinidad", code: "en_tt", usb_code: 0x2c09},
+        ENGLISH___GREAT_BRITAIN:        {name: "English - Great Britain", code: "en_gb", usb_code: 0x0809},
+        ENGLISH___UNITED_STATES:        {name: "English - United States", code: "en_us", usb_code: 0x0409},
+        ESTONIAN:                       {name: "Estonian", code: "et", usb_code: 0x0425},
+        FARSI:                          {name: "Farsi", code: "fa", usb_code: 0x0429},
+        FINNISH:                        {name: "Finnish", code: "fi", usb_code: 0x040b},
+        FAROESE:                        {name: "Faroese", code: "fo", usb_code: 0x0438},
+        FRENCH___FRANCE:                {name: "French - France", code: "fr_fr", usb_code: 0x040c},
+        FRENCH___BELGIUM:               {name: "French - Belgium", code: "fr_be", usb_code: 0x080c},
+        FRENCH___CANADA:                {name: "French - Canada", code: "fr_ca", usb_code: 0x0c0c},
+        FRENCH___LUXEMBOURG:            {name: "French - Luxembourg", code: "fr_lu", usb_code: 0x140c},
+        FRENCH___SWITZERLAND:           {name: "French - Switzerland", code: "fr_ch", usb_code: 0x100c},
+        GAELIC___IRELAND:               {name: "Gaelic - Ireland", code: "gd_ie", usb_code: 0x083c},
+        GAELIC___SCOTLAND:              {name: "Gaelic - Scotland", code: "gd", usb_code: 0x043c},
+        GERMAN___GERMANY:               {name: "German - Germany", code: "de_de", usb_code: 0x0407},
+        GERMAN___AUSTRIA:               {name: "German - Austria", code: "de_at", usb_code: 0x0c07},
+        GERMAN___LIECHTENSTEIN:         {name: "German - Liechtenstein", code: "de_li", usb_code: 0x1407},
+        GERMAN___LUXEMBOURG:            {name: "German - Luxembourg", code: "de_lu", usb_code: 0x1007},
+        GERMAN___SWITZERLAND:           {name: "German - Switzerland", code: "de_ch", usb_code: 0x0807},
+        GREEK:                          {name: "Greek", code: "el", usb_code: 0x0408},
+        HEBREW:                         {name: "Hebrew", code: "he", usb_code: 0x040d},
+        HINDI:                          {name: "Hindi", code: "hi", usb_code: 0x0439},
+        HUNGARIAN:                      {name: "Hungarian", code: "hu", usb_code: 0x040e},
+        ICELANDIC:                      {name: "Icelandic", code: "is", usb_code: 0x040f},
+        INDONESIAN:                     {name: "Indonesian", code: "id", usb_code: 0x0421},
+        ITALIAN___ITALY:                {name: "Italian - Italy", code: "it_it", usb_code: 0x0410},
+        ITALIAN___SWITZERLAND:          {name: "Italian - Switzerland", code: "it_ch", usb_code: 0x0810},
+        JAPANESE:                       {name: "Japanese", code: "ja", usb_code: 0x0411},
+        KOREAN:                         {name: "Korean", code: "ko", usb_code: 0x0412},
+        LATVIAN:                        {name: "Latvian", code: "lv", usb_code: 0x0426},
+        LITHUANIAN:                     {name: "Lithuanian", code: "lt", usb_code: 0x0427},
+        F_Y_R_O__MACEDONIA:             {name: "F.Y.R.O. Macedonia", code: "mk", usb_code: 0x042f},
+        MALAY___MALAYSIA:               {name: "Malay - Malaysia", code: "ms_my", usb_code: 0x043e},
+        MALAY___BRUNEI:                 {name: "Malay – Brunei", code: "ms_bn", usb_code: 0x083e},
+        MALTESE:                        {name: "Maltese", code: "mt", usb_code: 0x043a},
+        MARATHI:                        {name: "Marathi", code: "mr", usb_code: 0x044e},
+        NORWEGIAN___BOKML:              {name: "Norwegian - Bokml", code: "no_no", usb_code: 0x0414},
+        NORWEGIAN___NYNORSK:            {name: "Norwegian - Nynorsk", code: "no_no", usb_code: 0x0814},
+        POLISH:                         {name: "Polish", code: "pl", usb_code: 0x0415},
+        PORTUGUESE___PORTUGAL:          {name: "Portuguese - Portugal", code: "pt_pt", usb_code: 0x0816},
+        PORTUGUESE___BRAZIL:            {name: "Portuguese - Brazil", code: "pt_br", usb_code: 0x0416},
+        RAETO_ROMANCE:                  {name: "Raeto-Romance", code: "rm", usb_code: 0x0417},
+        ROMANIAN___ROMANIA:             {name: "Romanian - Romania", code: "ro", usb_code: 0x0418},
+        ROMANIAN___REPUBLIC_OF_MOLDOVA: {name: "Romanian - Republic of Moldova", code: "ro_mo", usb_code: 0x0818},
+        RUSSIAN:                        {name: "Russian", code: "ru", usb_code: 0x0419},
+        RUSSIAN___REPUBLIC_OF_MOLDOVA:  {name: "Russian - Republic of Moldova", code: "ru_mo", usb_code: 0x0819},
+        SANSKRIT:                       {name: "Sanskrit", code: "sa", usb_code: 0x044f},
+        SERBIAN___CYRILLIC:             {name: "Serbian - Cyrillic", code: "sr_sp", usb_code: 0x0c1a},
+        SERBIAN___LATIN:                {name: "Serbian - Latin", code: "sr_sp", usb_code: 0x081a},
+        SETSUANA:                       {name: "Setsuana", code: "tn", usb_code: 0x0432},
+        SLOVENIAN:                      {name: "Slovenian", code: "sl", usb_code: 0x0424},
+        SLOVAK:                         {name: "Slovak", code: "sk", usb_code: 0x041b},
+        SORBIAN:                        {name: "Sorbian", code: "sb", usb_code: 0x042e},
+        SPANISH___SPAIN__TRADITIONAL_:  {name: "Spanish - Spain (Traditional)", code: "es_es", usb_code: 0x040a},
+        SPANISH___ARGENTINA:            {name: "Spanish - Argentina", code: "es_ar", usb_code: 0x2c0a},
+        SPANISH___BOLIVIA:              {name: "Spanish - Bolivia", code: "es_bo", usb_code: 0x400a},
+        SPANISH___CHILE:                {name: "Spanish - Chile", code: "es_cl", usb_code: 0x340a},
+        SPANISH___COLOMBIA:             {name: "Spanish - Colombia", code: "es_co", usb_code: 0x240a},
+        SPANISH___COSTA_RICA:           {name: "Spanish - Costa Rica", code: "es_cr", usb_code: 0x140a},
+        SPANISH___DOMINICAN_REPUBLIC:   {name: "Spanish - Dominican Republic", code: "es_do", usb_code: 0x1c0a},
+        SPANISH___ECUADOR:              {name: "Spanish - Ecuador", code: "es_ec", usb_code: 0x300a},
+        SPANISH___GUATEMALA:            {name: "Spanish - Guatemala", code: "es_gt", usb_code: 0x100a},
+        SPANISH___HONDURAS:             {name: "Spanish - Honduras", code: "es_hn", usb_code: 0x480a},
+        SPANISH___MEXICO:               {name: "Spanish - Mexico", code: "es_mx", usb_code: 0x080a},
+        SPANISH___NICARAGUA:            {name: "Spanish - Nicaragua", code: "es_ni", usb_code: 0x4c0a},
+        SPANISH___PANAMA:               {name: "Spanish - Panama", code: "es_pa", usb_code: 0x180a},
+        SPANISH___PERU:                 {name: "Spanish - Peru", code: "es_pe", usb_code: 0x280a},
+        SPANISH___PUERTO_RICO:          {name: "Spanish - Puerto Rico", code: "es_pr", usb_code: 0x500a},
+        SPANISH___PARAGUAY:             {name: "Spanish - Paraguay", code: "es_py", usb_code: 0x3c0a},
+        SPANISH___EL_SALVADOR:          {name: "Spanish - El Salvador", code: "es_sv", usb_code: 0x440a},
+        SPANISH___URUGUAY:              {name: "Spanish - Uruguay", code: "es_uy", usb_code: 0x380a},
+        SPANISH___VENEZUELA:            {name: "Spanish - Venezuela", code: "es_ve", usb_code: 0x200a},
+        SOUTHERN_SOTHO:                 {name: "Southern Sotho", code: "st", usb_code: 0x0430},
+        SWAHILI:                        {name: "Swahili", code: "sw", usb_code: 0x0441},
+        SWEDISH___SWEDEN:               {name: "Swedish - Sweden", code: "sv_se", usb_code: 0x041d},
+        SWEDISH___FINLAND:              {name: "Swedish - Finland", code: "sv_fi", usb_code: 0x081d},
+        TAMIL:                          {name: "Tamil", code: "ta", usb_code: 0x0449},
+        TATAR:                          {name: "Tatar", code: "tt", usb_code: 0x0444},
+        THAI:                           {name: "Thai", code: "th", usb_code: 0x041e},
+        TURKISH:                        {name: "Turkish", code: "tr", usb_code: 0x041f},
+        TSONGA:                         {name: "Tsonga", code: "ts", usb_code: 0x0431},
+        UKRAINIAN:                      {name: "Ukrainian", code: "uk", usb_code: 0x0422},
+        URDU:                           {name: "Urdu", code: "ur", usb_code: 0x0420},
+        UZBEK___CYRILLIC:               {name: "Uzbek - Cyrillic", code: "uz_uz", usb_code: 0x0843},
+        UZBEK___LATIN:                  {name: "Uzbek – Latin", code: "uz_uz", usb_code: 0x0443},
+        VIETNAMESE:                     {name: "Vietnamese", code: "vi", usb_code: 0x042a},
+        XHOSA:                          {name: "Xhosa", code: "xh", usb_code: 0x0434},
+        YIDDISH:                        {name: "Yiddish", code: "yi", usb_code: 0x043d},
+        ZULU:                           {name: "Zulu", code: "zu", usb_code: 0x0435},
+    }.freeze.each{|_,data| data.each{|_,val| val.freeze}; data.freeze}    # make the constant contents constant
+
+    private_constant :KNOWN
+
+    ##
+    # Gets a language by key or name.
+    def self.[](name)
+      get_by_name(name)
+    end
+
+    # :nodoc:
+    def self.[]=(*args)
+      raise 'can\'t modify constants'
+    end
+
+
+    ##
+    # Gets a language by name.
+    def self.get_by_name(name)
+      name_sym = name.to_s.upcase.to_sym
+      name = name.to_s.downcase
+      if KNOWN.keys.include?(name_sym)
+        return KNOWN[name_sym]
+      else
+        res = KNOWN.find{|k,v| v[:name].downcase == name}
+        return res[1] if res && res.length == 2
+      end
+      nil
+    end
+
+    ##
+    # Gets a language by code.
+    def self.get_by_code(code)
+      code = code.to_s.downcase
+      res = KNOWN.find{|k,v| v[:code] == code}
+      return res[1] if res && res.length == 2
+    end
+
+    ##
+    # Gets a language by USB code.
+    def self.get_by_usb_code(code)
+      code = code.to_i
+      res = KNOWN.find{|k,v| v[:usb_code] == code}
+      return res[1] if res && res.length == 2
+    end
+
+    ##
+    # Gets a language.
+    #
+    # The input value can be the name, code, or USB code.
+    def self.get(language)
+      if language.is_a?(Numeric)
+        get_by_usb_code(language)
+      elsif language.is_a?(Symbol) || language.is_a?(String)
+        get_by_name(language) || get_by_code(language)
+      elsif language.is_a?(Hash)
+        if language[:usb_code]
+          get_by_usb_code(language[:usb_code])
+        elsif language[:code]
+          get_by_code(language[:code])
+        elsif language[:name]
+          get_by_name(language[:name])
+        else
+          nil
+        end
+      else
+        nil
+      end
+    end
+
+    # :nodoc:
+    def self.method_missing(m,*a,&b)
+      if KNOWN.respond_to?(m)
+        KNOWN.send m, *a, &b
+      else
+        super m, *a, &b
+      end
+    end
+
+
+  end
+end

data/lib/hidapi/numeric_extensions.rb

@@ -0,0 +1,10 @@
+
+Fixnum.class_eval do
+
+  ##
+  # Converts an integer into a hex string with the specified length.
+  def to_hex(length = 8)
+    to_s(16).rjust(length, '0')
+  end
+
+end

data/lib/hidapi/setup_task_helper.rb

@@ -0,0 +1,240 @@
+#!/usr/bin/env ruby
+
+require 'tmpdir'
+
+module HIDAPI
+  class SetupTaskHelper
+
+    attr_reader :vendor_id, :product_id, :simple_name, :interface
+
+    def initialize(vendor_id, product_id, simple_name, interface)
+      @vendor_id = vendor_id.to_s.strip.to_i(16)
+      @product_id = product_id.to_s.strip.to_i(16)
+      @simple_name = simple_name.to_s.strip.gsub(' ', '_').gsub(/[^A-Za-z0-9_\-]/, '')
+      @interface = interface.to_s.strip.to_i
+      @temp_dir = Dir.mktmpdir('hidapi_setup')
+      ObjectSpace.define_finalizer(self, ->{ FileUtils.rm_rf(@temp_dir) })
+    end
+
+    def run
+      if valid_options?
+        if operating_system == :osx
+          run_osx
+        elsif operating_system == :linux
+          run_linux
+        elsif operating_system == :windows
+          run_windows
+        else
+          puts "Your operating system was detected as '#{operating_system}', but I don't have a setup routine for that."
+          false
+        end
+      else
+        usage
+      end
+    end
+
+    def valid_options?
+      vendor_id != 0 && product_id != 0 && simple_name != ''
+    end
+
+    def usage()
+      puts <<-USAGE
+Usage:  bundle exec rake setup_hid_device[vendor_id,product_id,simple_name,interface]
+-OR-    #{File.basename(__FILE__)} vendor_id product_id simple_name interface
+  vendor_id should be the 16-bit identifier assigned to the device vendor in hex format.
+  product_id should be the 16-bit identifier assigned by the manufacturer in hex format.
+  simple_name should be a fairly short name for the device.
+  interface is optional and defaults to 0.
+
+  ie - bundle exec rake setup_hid_device[04d8,c002,pico-lcd-graphic]
+  ie - #{File.basename(__FILE__)} 04d8 c002 pico-lcd-graphic
+USAGE
+      false
+    end
+
+    private
+
+    def operating_system
+      @operating_system ||=
+          begin
+
+            # unix uses uname, windows uses ver.  failing both, use the OS environment variable (which can be specified by the user).
+            kernel_name = `uname -s`.strip.downcase rescue nil
+            kernel_name = `ver`.strip.downcase rescue nil unless kernel_name
+            kernel_name = ENV['OS'].to_s.strip.downcase rescue '' unless kernel_name
+
+            if /darwin/ =~ kernel_name
+              :osx
+            elsif /win/ =~ kernel_name
+              :windows
+            elsif /linux/ =~ kernel_name
+              :linux
+            else
+              :unix
+            end
+          rescue
+            :unknown
+          end
+    end
+
+    def run_windows
+      puts "Please use the Zadig tool from http://zadig.akeo.ie/ to install a driver for your device.\nThis script unfortunately does not do this for you automatically at this point in time."
+    end
+
+    def run_osx
+      # OS X needs a codeless kext setup in the /System/Library/Extensions directory.
+
+      path = @temp_dir
+      path += '/' unless path[-1] == '/'
+      path += simple_name
+
+      target = "/System/Library/Extensions/#{simple_name}.kext"
+
+      if Dir.exist?(target)
+        puts 'A kext with the specified name already exists.'
+        return false
+      end
+
+      puts 'Building kext...'
+      Dir.mkdir path
+      Dir.mkdir path + '/Contents'
+      Dir.mkdir path + '/Contents/Resources'
+      Dir.mkdir path + '/Contents/Resources/English.lproj'
+      File.write path + '/Contents/Resources/English.lproj/InfoPlist.strings', "\nCFBundleName = \"VendorSpecificDriver\";\n"
+      File.write path + '/Contents/Info.plist', <<-FILE
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>BuildMachineOSBuild</key>
+	<string>11C74</string>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>English</string>
+	<key>CFBundleIdentifier</key>
+	<string>idv.barkerest.#{simple_name}</string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundlePackageType</key>
+	<string>KEXT</string>
+	<key>CFBundleSignature</key>
+	<string>????</string>
+	<key>CFBundleVersion</key>
+	<string>1.0</string>
+	<key>DTCompiler</key>
+	<string></string>
+	<key>DTPlatformBuild</key>
+	<string>4D502</string>
+	<key>DTPlatformVersion</key>
+	<string>GM</string>
+	<key>DTSDKBuild</key>
+	<string>11C63</string>
+	<key>DTSDKName</key>
+	<string>macosx10.7</string>
+	<key>DTXcode</key>
+	<string>0421</string>
+	<key>DTXcodeBuild</key>
+	<string>4D502</string>
+	<key>OSBundleRequired</key>
+	<string>Console</string>
+	<key>IOKitPersonalities</key>
+	<dict>
+    <key>#{simple_name}</key>
+		<dict>
+			<key>CFBundleIdentifier</key>
+			<string>com.apple.kpi.iokit</string>
+			<key>IOClass</key>
+			<string>IOService</string>
+			<key>IOProbeScore</key>
+			<integer>11000</integer>
+			<key>IOProviderClass</key>
+			<string>IOUSBInterface</string>
+			<key>bConfigurationValue</key>
+			<integer>1</integer>
+			<key>bInterfaceNumber</key>
+			<integer>#{interface}</integer>
+			<key>idProduct</key>
+			<integer>#{product_id}</integer>
+			<key>idVendor</key>
+			<integer>#{vendor_id}</integer>
+		</dict>
+	</dict>
+	<key>OSBundleLibraries</key>
+	<dict>
+		<key>com.apple.iokit.IOUSBFamily</key>
+		<string>1.8</string>
+		<key>com.apple.kernel.libkern</key>
+		<string>6.0</string>
+	</dict>
+</dict>
+</plist>
+      FILE
+
+      puts 'Installing kext...'
+      `sudo cp -r #{path} #{target}`
+      `sudo touch /System/Library/Extensions`
+
+      FileUtils.rm_rf path
+
+      puts "The kext has been installed.\nYou may have to unplug/plug the device or restart your computer."
+
+      true
+    end
+
+    def run_linux
+      # Linux needs a udev rule file added under /etc/udev/rules.d
+      # We'll use '60-hidapi.rules' for our purposes.
+
+      target = '/etc/udev/rules.d/60-hidapi.rules'
+
+      contents = File.exist?(target) ? File.read(target) : nil
+      contents ||= <<-DEF
+# udev rules for libusb access created by Ruby 'hidapi' gem.
+SUBSYSTEM!="usb", GOTO="hidapi_rules_end"
+ACTION!="add", GOTO="hidapi_rules_end"
+
+LABEL="hidapi_rules_end"
+      DEF
+
+      contents = contents.split("\n").map(&:strip)
+
+      # get the position we will be inserting at.
+      last_line = contents.index { |item| item == 'LABEL="hidapi_rules_end"' }
+
+      contents.each do |line|
+        if /^#\s+device:\s+#{simple_name}$/i =~ line
+          puts 'A udev rule for the specified device already exists.'
+          return false
+        end
+      end
+
+      line = "# device: #{simple_name}\nATTR{idVendor}==\"#{vendor_id.to_s(16).rjust(4,'0')}\", ATTR{idProduct}==\"#{product_id.to_s(16).rjust(4,'0')}\", MODE=\"0666\", SYMLINK+=\"hidapi/#{simple_name}@%k\"\n"
+
+      if last_line
+        contents.insert last_line, line
+      else
+        contents << line
+      end
+
+      path = @temp_dir
+      path += '/' unless path[-1] == '/'
+      path += 'rules'
+
+      File.write path, contents.join("\n")
+
+      `sudo cp -f #{path} #{target}`
+
+      File.delete path
+
+      puts "A udev rule for the device has been created.\nYou may have to unplug/plug the device or restart your computer."
+      true
+    end
+
+  end
+end
+
+
+if $0 == __FILE__
+
+  HIDAPI::SetupTaskHelper(ARGV[0], ARGV[1], ARGV[2], ARGV[3]).run
+
+end