ligo 0.1.0.beta

data/.document

@@ -0,0 +1,3 @@
+- 
+ChangeLog.md
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,2 @@
+doc/
+pkg/

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title "ligo Documentation" --protected

data/ChangeLog.md

@@ -0,0 +1,4 @@
+### 0.1.0 / 2012-12-06
+
+* Initial release:
+

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/NOTICE.txt

@@ -0,0 +1,6 @@
+
+   The ligo project
+   Copyright (C) 2012 Renaud AUBIN
+
+   This product includes software developed by
+   Renaud AUBIN (http://blog.renaud.io/).

data/README.md

@@ -0,0 +1,95 @@
+<!--- coding: utf-8; fill-column: 80 --->
+# ligō
+
+* [Homepage](https://github.com/nibua-r/ligo#readme)
+* [Issues](https://github.com/nibua-r/ligo/issues)
+* [Documentation](http://rubydoc.info/gems/ligo/frames)
+* [Email](mailto:root at renaud.io)
+
+## Description
+
+ligō is a ruby gem implementing the
+[Android Open Accessory Protocol](http://source.android.com/tech/accessories/aoap/aoa.html)
+to interact with Android devices via USB.
+
+Android-side application is needed to make some use of this project. A
+[sample LigoTextDemo Android application](https://github.com/nibua-r/LigoTextDemo)
+is available for usage demonstration.
+
+## Features
+
+Just USB I/O using the Android Open Accessory Protocol…
+
+## Examples
+
+```ruby
+require 'ligo'
+
+id = {
+  manufacturer: 'Ligo',
+  model:        'VirtualAccessory',
+  description:  'PC acts as an accessory!',
+  version:      '0.1',
+  uri:          'http://blog.renaud.io',
+  serial:       '3678000012345678'
+}
+
+Ligo::Logging.configure_logger_output('/tmp/ligo-sample.log')
+ctx = Ligo::Context.new
+acc = Ligo::Accessory.new(id)
+
+# You could inspect the Android devices list
+puts ctx.devices.inspect
+
+# Take the first one
+dev = ctx.devices.first
+
+# Switch the Android device to accessory mode
+success = dev.attach_accessory(acc)
+
+# then operate on the device (you'll need some Android code for this!)
+if success
+  dev.process do |handle|
+    # I/O
+  end
+end
+```
+
+## Requirements
+
+ligō will be nothing without the
+[LIBUSB Ruby binding](https://github.com/larskanis/libusb) and the underlying
+[libusb](http://libusbx.org/) library.
+
+At the time of writing, ligō focuses on the GNU/Linux operating system and
+YARV/MRI ruby. ligō has been developed and tested on Debian GNU/Linux with ruby
+1.9.3p327.
+
+ligō is useless without Android-side application. A
+[sample LigoTextDemo Android application](https://github.com/nibua-r/LigoTextDemo)
+is available for usage demonstration.
+
+## Install
+
+ligō is currently under developement, as a consequence you'll need to live on the edge:
+
+    $ git clone https://github.com/nibua-r/ligo.git
+    $ cd ligo
+    $ rake install
+
+As soon as the ligō gem is released, you shall install by using:
+
+    $ gem install ligo
+
+## Pending tasks
+
+* Write the specs and automate testing!
+* Provide an Android demo application
+* Improve the documentation
+* Release and push the gem to rubygems.org
+
+## Copyright
+
+Copyright (c) 2012 Renaud AUBIN
+
+See {file:LICENSE.txt} for details.

data/Rakefile

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'rake'
+
+begin
+  gem 'rubygems-tasks', '~> 0.2'
+  require 'rubygems/tasks'
+
+  Gem::Tasks.new
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install rubygems-tasks` to install Gem::Tasks."
+end
+
+begin
+  gem 'rspec', '~> 2.4'
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new
+rescue LoadError => e
+  task :spec do
+    abort "Please run `gem install rspec` to install RSpec."
+  end
+end
+
+task :test    => :spec
+task :default => :spec
+
+begin
+  gem 'yard', '~> 0.8'
+  require 'yard'
+
+  YARD::Rake::YardocTask.new  
+rescue LoadError => e
+  task :yard do
+    abort "Please run `gem install yard` to install YARD."
+  end
+end
+task :doc => :yard

data/bin/ligo-sample

@@ -0,0 +1,87 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8; fill-column: 80 -*-
+
+require 'ligo'
+
+id = {
+  manufacturer: 'Ligo',
+  model:        'VirtualAccessory',
+  description:  'PC acts as an accessory!',
+  version:      '0.1',
+  uri:          'http://blog.renaud.io',
+  serial:       '3678000012345678'
+}
+
+Ligo::Logging.configure_logger_output('/tmp/ligo-sample.log')
+ctx = Ligo::Context.new
+acc = Ligo::Accessory.new(id)
+dev = ctx.devices.first
+
+unless dev
+  puts 'No device found ⇒ Exit'
+  exit
+end
+
+if dev.attach_accessory(acc)
+
+  begin
+
+    dev.process do |handle|
+
+      puts <<-eof
+
+The selected android device should now ask to switch to Accessory Mode.
+The log file is /tmp/ligo-sample.log.
+Once you have accepted: type some strings and send them to the selected device by hitting Enter
+(use Ctrl-C to quit):
+
+eof
+
+      reader_t = nil
+      writer_t = nil
+
+      mutex = Mutex.new
+
+      reader_t = Thread.new do
+        loop do
+          res = nil
+          mutex.synchronize do
+            output_string = dev.recv(1024)
+            unless output_string.nil?
+              puts "IN  -- String received: #{output_string}"
+            end
+          end
+          # get some time to write data if any
+          sleep 0.2
+        end
+      end
+
+      writer_t = Thread.new do
+        loop do
+          if s = gets
+            mutex.synchronize do
+              bytes_sent = dev.send(s)
+              if bytes_sent == s.bytesize
+                puts "OUT -- String '#{s.chomp}' of size #{bytes_sent} bytes successfully sent"
+              else
+                puts "OUT -- Error / String '#{s.chomp}' of size #{bytes_sent} bytes not successfully sent"
+              end
+            end
+          end
+        end
+      end
+
+      reader_t.abort_on_exception = true
+      writer_t.abort_on_exception = true
+      reader_t.join
+      writer_t.join
+
+    end
+
+  rescue SystemExit, Interrupt => e
+    puts "#{e.message} ⇒ Exit"
+    Thread.list.each { |t| t.exit }
+  end
+
+
+end

data/lib/ligo/accessory.rb

@@ -0,0 +1,64 @@
+# -*- coding: utf-8; fill-column: 80 -*-
+#
+# Copyright (c) 2012 Renaud AUBIN
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Ligo
+
+  class Accessory
+    include Logging
+
+    # http://stackoverflow.com/questions/2680523/dry-ruby-initialization-with-hash-argument
+    attr_reader :id, :manufacturer, :model, :description, :version, :uri, :serial
+
+    DEFAULT_ID = {
+      manufacturer: 'ligō',
+      model:        'Demo',
+      description:  'ligō virtual accessory',
+      version:      '1.0',
+      uri:          'https://github.com/nibua-r/ligo#readme',
+      serial:       '6c6967c58d20312e30' # 'ligō 1.0'.each_byte {|c| print c.to_i.to_s(16), '' }
+    }
+
+    def initialize(id = DEFAULT_ID)
+
+      raise ArgumentError, '#new must be called with a Hash' unless id.is_a? Hash
+
+      required_ids = [:manufacturer, :model, :description, :version, :uri, :serial]
+      required_ids.each do |sym|
+        raise ArgumentError, "Missing argument: #{sym}" unless id.include? sym
+      end
+
+      id.each do |k, v|
+        raise ArgumentError, "#{k} is not a String" unless v.is_a? String
+        raise ArgumentError, "#{k} must not be empty" if v.empty?
+        raise ArgumentError, "#{k} must contain at most 255 bytes" if v.bytesize > 255
+        instance_variable_set "@#{k}", v unless v.nil?
+      end
+
+      @id = id
+      logger.debug self.inspect
+    end
+
+    def each(&block)
+      @id.each(&block)
+    end
+
+    def keys
+      @id.keys
+    end
+  end
+
+end

data/lib/ligo/constants.rb

@@ -0,0 +1,83 @@
+#
+# Copyright (c) 2012 Renaud AUBIN
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Ligo
+
+  # Android devices Vendor Ids
+  # @see android source code system/core/adb/usb_vendor.c
+  VENDOR_IDS = [
+                GOOGLE_VID          = 0x18d1,
+                INTEL_VID           = 0x8087,
+                HTC_VID             = 0x0bb4,
+                SAMSUNG_VID         = 0x04e8,
+                MOTOROLA_VID        = 0x22b8,
+                LGE_VID             = 0x1004,
+                HUAWEI_VID          = 0x12D1,
+                ACER_VID            = 0x0502,
+                SONY_ERICSSON_VID   = 0x0FCE,
+                FOXCONN_VID         = 0x0489,
+                DELL_VID            = 0x413c,
+                NVIDIA_VID          = 0x0955,
+                GARMIN_ASUS_VID     = 0x091E,
+                SHARP_VID           = 0x04dd,
+                ZTE_VID             = 0x19D2,
+                KYOCERA_VID         = 0x0482,
+                PANTECH_VID         = 0x10A9,
+                QUALCOMM_VID        = 0x05c6,
+                OTGV_VID            = 0x2257,
+                NEC_VID             = 0x0409,
+                PMC_VID             = 0x04DA,
+                TOSHIBA_VID         = 0x0930,
+                SK_TELESYS_VID      = 0x1F53,
+                KT_TECH_VID         = 0x2116,
+                ASUS_VID            = 0x0b05,
+                PHILIPS_VID         = 0x0471,
+                TI_VID              = 0x0451,
+                FUNAI_VID           = 0x0F1C,
+                GIGABYTE_VID        = 0x0414,
+                IRIVER_VID          = 0x2420,
+                COMPAL_VID          = 0x1219,
+                T_AND_A_VID         = 0x1BBB,
+                LENOVOMOBILE_VID    = 0x2006,
+                LENOVO_VID          = 0x17EF,
+                VIZIO_VID           = 0xE040,
+                K_TOUCH_VID         = 0x24E3,
+                PEGATRON_VID        = 0x1D4D,
+                ARCHOS_VID          = 0x0E79,
+                POSITIVO_VID        = 0x1662,
+                FUJITSU_VID         = 0x04C5,
+                LUMIGON_VID         = 0x25E3,
+                QUANTA_VID          = 0x0408,
+                INQ_MOBILE_VID      = 0x2314,
+                SONY_VID            = 0x054C,
+                YULONG_COOLPAD_VID  = 0x1EBF
+               ]
+
+  # Accessory Protocol allowed product ids
+  GOOGLE_PIDS = *(0x2d00..0x2d05)
+
+  ## Accessory Protocol Commands
+  # Accessory Protocol "Get Protocol" command
+  COMMAND_GETPROTOCOL = 51
+  # Accessory Protocol "Send Id String" command
+  COMMAND_SENDSTRING  = 52
+  # Accessory Protocol "Accessory Mode Start Up" commands
+  COMMAND_START       = 53
+
+  # USB reenumeration delay in seconds
+  REENUMERATION_DELAY = 1
+
+end

data/lib/ligo/context.rb

@@ -0,0 +1,50 @@
+# -*- coding: utf-8; fill-column: 80 -*-
+#
+# Copyright (c) 2012 Renaud AUBIN
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+# TODO: Add a proper mention to libusb LGPL licensing since the following code
+# is a derivative work of Lars Kanis LIBUSB::Context.
+
+module Ligo
+
+  class Context < LIBUSB::Context
+    include LIBUSB
+
+    def device_list
+      pppDevs = FFI::MemoryPointer.new :pointer
+      size = Call.libusb_get_device_list(@ctx, pppDevs)
+      ppDevs = pppDevs.read_pointer
+      pDevs = []
+      size.times do |devi|
+        pDev = ppDevs.get_pointer(devi*FFI.type_size(:pointer))
+        # Use Ligo::Device instead of LIBUSB::Device
+        device = Ligo::Device.new(self, pDev)
+        if VENDOR_IDS.include?(device.idVendor)
+          begin
+            # Include only AOAP compatible devices
+            pDevs << device if device.aoap?
+          rescue LIBUSB::ERROR_ACCESS
+            # TODO: do something about this exception, log at least!
+          end
+        end
+      end
+      Call.libusb_free_device_list(ppDevs, 1)
+      pDevs
+    end
+    private :device_list
+  end
+
+end