ligo 0.1.0.beta
Sign up to get free protection for your applications and to get access to all the features.
- data/.document +3 -0
- data/.gitignore +2 -0
- data/.rspec +1 -0
- data/.yardopts +1 -0
- data/ChangeLog.md +4 -0
- data/LICENSE.txt +202 -0
- data/NOTICE.txt +6 -0
- data/README.md +95 -0
- data/Rakefile +40 -0
- data/bin/ligo-sample +87 -0
- data/lib/ligo/accessory.rb +64 -0
- data/lib/ligo/constants.rb +83 -0
- data/lib/ligo/context.rb +50 -0
- data/lib/ligo/device.rb +300 -0
- data/lib/ligo/logging.rb +54 -0
- data/lib/ligo/version.rb +21 -0
- data/lib/ligo.rb +38 -0
- data/ligo.gemspec +28 -0
- data/spec/ligo/accessory_spec.rb +99 -0
- data/spec/ligo/context_spec.rb +21 -0
- data/spec/ligo/device_spec.rb +45 -0
- data/spec/ligo_spec.rb +7 -0
- data/spec/spec_helper.rb +6 -0
- metadata +155 -0
data/.document
ADDED
data/.gitignore
ADDED
data/.rspec
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
--colour --format documentation
|
data/.yardopts
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
--markup markdown --title "ligo Documentation" --protected
|
data/ChangeLog.md
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
data/NOTICE.txt
ADDED
data/README.md
ADDED
@@ -0,0 +1,95 @@
|
|
1
|
+
<!--- coding: utf-8; fill-column: 80 --->
|
2
|
+
# ligō
|
3
|
+
|
4
|
+
* [Homepage](https://github.com/nibua-r/ligo#readme)
|
5
|
+
* [Issues](https://github.com/nibua-r/ligo/issues)
|
6
|
+
* [Documentation](http://rubydoc.info/gems/ligo/frames)
|
7
|
+
* [Email](mailto:root at renaud.io)
|
8
|
+
|
9
|
+
## Description
|
10
|
+
|
11
|
+
ligō is a ruby gem implementing the
|
12
|
+
[Android Open Accessory Protocol](http://source.android.com/tech/accessories/aoap/aoa.html)
|
13
|
+
to interact with Android devices via USB.
|
14
|
+
|
15
|
+
Android-side application is needed to make some use of this project. A
|
16
|
+
[sample LigoTextDemo Android application](https://github.com/nibua-r/LigoTextDemo)
|
17
|
+
is available for usage demonstration.
|
18
|
+
|
19
|
+
## Features
|
20
|
+
|
21
|
+
Just USB I/O using the Android Open Accessory Protocol…
|
22
|
+
|
23
|
+
## Examples
|
24
|
+
|
25
|
+
```ruby
|
26
|
+
require 'ligo'
|
27
|
+
|
28
|
+
id = {
|
29
|
+
manufacturer: 'Ligo',
|
30
|
+
model: 'VirtualAccessory',
|
31
|
+
description: 'PC acts as an accessory!',
|
32
|
+
version: '0.1',
|
33
|
+
uri: 'http://blog.renaud.io',
|
34
|
+
serial: '3678000012345678'
|
35
|
+
}
|
36
|
+
|
37
|
+
Ligo::Logging.configure_logger_output('/tmp/ligo-sample.log')
|
38
|
+
ctx = Ligo::Context.new
|
39
|
+
acc = Ligo::Accessory.new(id)
|
40
|
+
|
41
|
+
# You could inspect the Android devices list
|
42
|
+
puts ctx.devices.inspect
|
43
|
+
|
44
|
+
# Take the first one
|
45
|
+
dev = ctx.devices.first
|
46
|
+
|
47
|
+
# Switch the Android device to accessory mode
|
48
|
+
success = dev.attach_accessory(acc)
|
49
|
+
|
50
|
+
# then operate on the device (you'll need some Android code for this!)
|
51
|
+
if success
|
52
|
+
dev.process do |handle|
|
53
|
+
# I/O
|
54
|
+
end
|
55
|
+
end
|
56
|
+
```
|
57
|
+
|
58
|
+
## Requirements
|
59
|
+
|
60
|
+
ligō will be nothing without the
|
61
|
+
[LIBUSB Ruby binding](https://github.com/larskanis/libusb) and the underlying
|
62
|
+
[libusb](http://libusbx.org/) library.
|
63
|
+
|
64
|
+
At the time of writing, ligō focuses on the GNU/Linux operating system and
|
65
|
+
YARV/MRI ruby. ligō has been developed and tested on Debian GNU/Linux with ruby
|
66
|
+
1.9.3p327.
|
67
|
+
|
68
|
+
ligō is useless without Android-side application. A
|
69
|
+
[sample LigoTextDemo Android application](https://github.com/nibua-r/LigoTextDemo)
|
70
|
+
is available for usage demonstration.
|
71
|
+
|
72
|
+
## Install
|
73
|
+
|
74
|
+
ligō is currently under developement, as a consequence you'll need to live on the edge:
|
75
|
+
|
76
|
+
$ git clone https://github.com/nibua-r/ligo.git
|
77
|
+
$ cd ligo
|
78
|
+
$ rake install
|
79
|
+
|
80
|
+
As soon as the ligō gem is released, you shall install by using:
|
81
|
+
|
82
|
+
$ gem install ligo
|
83
|
+
|
84
|
+
## Pending tasks
|
85
|
+
|
86
|
+
* Write the specs and automate testing!
|
87
|
+
* Provide an Android demo application
|
88
|
+
* Improve the documentation
|
89
|
+
* Release and push the gem to rubygems.org
|
90
|
+
|
91
|
+
## Copyright
|
92
|
+
|
93
|
+
Copyright (c) 2012 Renaud AUBIN
|
94
|
+
|
95
|
+
See {file:LICENSE.txt} for details.
|
data/Rakefile
ADDED
@@ -0,0 +1,40 @@
|
|
1
|
+
# encoding: utf-8
|
2
|
+
|
3
|
+
require 'rubygems'
|
4
|
+
require 'rake'
|
5
|
+
|
6
|
+
begin
|
7
|
+
gem 'rubygems-tasks', '~> 0.2'
|
8
|
+
require 'rubygems/tasks'
|
9
|
+
|
10
|
+
Gem::Tasks.new
|
11
|
+
rescue LoadError => e
|
12
|
+
warn e.message
|
13
|
+
warn "Run `gem install rubygems-tasks` to install Gem::Tasks."
|
14
|
+
end
|
15
|
+
|
16
|
+
begin
|
17
|
+
gem 'rspec', '~> 2.4'
|
18
|
+
require 'rspec/core/rake_task'
|
19
|
+
|
20
|
+
RSpec::Core::RakeTask.new
|
21
|
+
rescue LoadError => e
|
22
|
+
task :spec do
|
23
|
+
abort "Please run `gem install rspec` to install RSpec."
|
24
|
+
end
|
25
|
+
end
|
26
|
+
|
27
|
+
task :test => :spec
|
28
|
+
task :default => :spec
|
29
|
+
|
30
|
+
begin
|
31
|
+
gem 'yard', '~> 0.8'
|
32
|
+
require 'yard'
|
33
|
+
|
34
|
+
YARD::Rake::YardocTask.new
|
35
|
+
rescue LoadError => e
|
36
|
+
task :yard do
|
37
|
+
abort "Please run `gem install yard` to install YARD."
|
38
|
+
end
|
39
|
+
end
|
40
|
+
task :doc => :yard
|
data/bin/ligo-sample
ADDED
@@ -0,0 +1,87 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
# -*- coding: utf-8; fill-column: 80 -*-
|
3
|
+
|
4
|
+
require 'ligo'
|
5
|
+
|
6
|
+
id = {
|
7
|
+
manufacturer: 'Ligo',
|
8
|
+
model: 'VirtualAccessory',
|
9
|
+
description: 'PC acts as an accessory!',
|
10
|
+
version: '0.1',
|
11
|
+
uri: 'http://blog.renaud.io',
|
12
|
+
serial: '3678000012345678'
|
13
|
+
}
|
14
|
+
|
15
|
+
Ligo::Logging.configure_logger_output('/tmp/ligo-sample.log')
|
16
|
+
ctx = Ligo::Context.new
|
17
|
+
acc = Ligo::Accessory.new(id)
|
18
|
+
dev = ctx.devices.first
|
19
|
+
|
20
|
+
unless dev
|
21
|
+
puts 'No device found ⇒ Exit'
|
22
|
+
exit
|
23
|
+
end
|
24
|
+
|
25
|
+
if dev.attach_accessory(acc)
|
26
|
+
|
27
|
+
begin
|
28
|
+
|
29
|
+
dev.process do |handle|
|
30
|
+
|
31
|
+
puts <<-eof
|
32
|
+
|
33
|
+
The selected android device should now ask to switch to Accessory Mode.
|
34
|
+
The log file is /tmp/ligo-sample.log.
|
35
|
+
Once you have accepted: type some strings and send them to the selected device by hitting Enter
|
36
|
+
(use Ctrl-C to quit):
|
37
|
+
|
38
|
+
eof
|
39
|
+
|
40
|
+
reader_t = nil
|
41
|
+
writer_t = nil
|
42
|
+
|
43
|
+
mutex = Mutex.new
|
44
|
+
|
45
|
+
reader_t = Thread.new do
|
46
|
+
loop do
|
47
|
+
res = nil
|
48
|
+
mutex.synchronize do
|
49
|
+
output_string = dev.recv(1024)
|
50
|
+
unless output_string.nil?
|
51
|
+
puts "IN -- String received: #{output_string}"
|
52
|
+
end
|
53
|
+
end
|
54
|
+
# get some time to write data if any
|
55
|
+
sleep 0.2
|
56
|
+
end
|
57
|
+
end
|
58
|
+
|
59
|
+
writer_t = Thread.new do
|
60
|
+
loop do
|
61
|
+
if s = gets
|
62
|
+
mutex.synchronize do
|
63
|
+
bytes_sent = dev.send(s)
|
64
|
+
if bytes_sent == s.bytesize
|
65
|
+
puts "OUT -- String '#{s.chomp}' of size #{bytes_sent} bytes successfully sent"
|
66
|
+
else
|
67
|
+
puts "OUT -- Error / String '#{s.chomp}' of size #{bytes_sent} bytes not successfully sent"
|
68
|
+
end
|
69
|
+
end
|
70
|
+
end
|
71
|
+
end
|
72
|
+
end
|
73
|
+
|
74
|
+
reader_t.abort_on_exception = true
|
75
|
+
writer_t.abort_on_exception = true
|
76
|
+
reader_t.join
|
77
|
+
writer_t.join
|
78
|
+
|
79
|
+
end
|
80
|
+
|
81
|
+
rescue SystemExit, Interrupt => e
|
82
|
+
puts "#{e.message} ⇒ Exit"
|
83
|
+
Thread.list.each { |t| t.exit }
|
84
|
+
end
|
85
|
+
|
86
|
+
|
87
|
+
end
|
@@ -0,0 +1,64 @@
|
|
1
|
+
# -*- coding: utf-8; fill-column: 80 -*-
|
2
|
+
#
|
3
|
+
# Copyright (c) 2012 Renaud AUBIN
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
#
|
17
|
+
|
18
|
+
module Ligo
|
19
|
+
|
20
|
+
class Accessory
|
21
|
+
include Logging
|
22
|
+
|
23
|
+
# http://stackoverflow.com/questions/2680523/dry-ruby-initialization-with-hash-argument
|
24
|
+
attr_reader :id, :manufacturer, :model, :description, :version, :uri, :serial
|
25
|
+
|
26
|
+
DEFAULT_ID = {
|
27
|
+
manufacturer: 'ligō',
|
28
|
+
model: 'Demo',
|
29
|
+
description: 'ligō virtual accessory',
|
30
|
+
version: '1.0',
|
31
|
+
uri: 'https://github.com/nibua-r/ligo#readme',
|
32
|
+
serial: '6c6967c58d20312e30' # 'ligō 1.0'.each_byte {|c| print c.to_i.to_s(16), '' }
|
33
|
+
}
|
34
|
+
|
35
|
+
def initialize(id = DEFAULT_ID)
|
36
|
+
|
37
|
+
raise ArgumentError, '#new must be called with a Hash' unless id.is_a? Hash
|
38
|
+
|
39
|
+
required_ids = [:manufacturer, :model, :description, :version, :uri, :serial]
|
40
|
+
required_ids.each do |sym|
|
41
|
+
raise ArgumentError, "Missing argument: #{sym}" unless id.include? sym
|
42
|
+
end
|
43
|
+
|
44
|
+
id.each do |k, v|
|
45
|
+
raise ArgumentError, "#{k} is not a String" unless v.is_a? String
|
46
|
+
raise ArgumentError, "#{k} must not be empty" if v.empty?
|
47
|
+
raise ArgumentError, "#{k} must contain at most 255 bytes" if v.bytesize > 255
|
48
|
+
instance_variable_set "@#{k}", v unless v.nil?
|
49
|
+
end
|
50
|
+
|
51
|
+
@id = id
|
52
|
+
logger.debug self.inspect
|
53
|
+
end
|
54
|
+
|
55
|
+
def each(&block)
|
56
|
+
@id.each(&block)
|
57
|
+
end
|
58
|
+
|
59
|
+
def keys
|
60
|
+
@id.keys
|
61
|
+
end
|
62
|
+
end
|
63
|
+
|
64
|
+
end
|
@@ -0,0 +1,83 @@
|
|
1
|
+
#
|
2
|
+
# Copyright (c) 2012 Renaud AUBIN
|
3
|
+
#
|
4
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
5
|
+
# you may not use this file except in compliance with the License.
|
6
|
+
# You may obtain a copy of the License at
|
7
|
+
#
|
8
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
9
|
+
#
|
10
|
+
# Unless required by applicable law or agreed to in writing, software
|
11
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
12
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
13
|
+
# See the License for the specific language governing permissions and
|
14
|
+
# limitations under the License.
|
15
|
+
#
|
16
|
+
|
17
|
+
module Ligo
|
18
|
+
|
19
|
+
# Android devices Vendor Ids
|
20
|
+
# @see android source code system/core/adb/usb_vendor.c
|
21
|
+
VENDOR_IDS = [
|
22
|
+
GOOGLE_VID = 0x18d1,
|
23
|
+
INTEL_VID = 0x8087,
|
24
|
+
HTC_VID = 0x0bb4,
|
25
|
+
SAMSUNG_VID = 0x04e8,
|
26
|
+
MOTOROLA_VID = 0x22b8,
|
27
|
+
LGE_VID = 0x1004,
|
28
|
+
HUAWEI_VID = 0x12D1,
|
29
|
+
ACER_VID = 0x0502,
|
30
|
+
SONY_ERICSSON_VID = 0x0FCE,
|
31
|
+
FOXCONN_VID = 0x0489,
|
32
|
+
DELL_VID = 0x413c,
|
33
|
+
NVIDIA_VID = 0x0955,
|
34
|
+
GARMIN_ASUS_VID = 0x091E,
|
35
|
+
SHARP_VID = 0x04dd,
|
36
|
+
ZTE_VID = 0x19D2,
|
37
|
+
KYOCERA_VID = 0x0482,
|
38
|
+
PANTECH_VID = 0x10A9,
|
39
|
+
QUALCOMM_VID = 0x05c6,
|
40
|
+
OTGV_VID = 0x2257,
|
41
|
+
NEC_VID = 0x0409,
|
42
|
+
PMC_VID = 0x04DA,
|
43
|
+
TOSHIBA_VID = 0x0930,
|
44
|
+
SK_TELESYS_VID = 0x1F53,
|
45
|
+
KT_TECH_VID = 0x2116,
|
46
|
+
ASUS_VID = 0x0b05,
|
47
|
+
PHILIPS_VID = 0x0471,
|
48
|
+
TI_VID = 0x0451,
|
49
|
+
FUNAI_VID = 0x0F1C,
|
50
|
+
GIGABYTE_VID = 0x0414,
|
51
|
+
IRIVER_VID = 0x2420,
|
52
|
+
COMPAL_VID = 0x1219,
|
53
|
+
T_AND_A_VID = 0x1BBB,
|
54
|
+
LENOVOMOBILE_VID = 0x2006,
|
55
|
+
LENOVO_VID = 0x17EF,
|
56
|
+
VIZIO_VID = 0xE040,
|
57
|
+
K_TOUCH_VID = 0x24E3,
|
58
|
+
PEGATRON_VID = 0x1D4D,
|
59
|
+
ARCHOS_VID = 0x0E79,
|
60
|
+
POSITIVO_VID = 0x1662,
|
61
|
+
FUJITSU_VID = 0x04C5,
|
62
|
+
LUMIGON_VID = 0x25E3,
|
63
|
+
QUANTA_VID = 0x0408,
|
64
|
+
INQ_MOBILE_VID = 0x2314,
|
65
|
+
SONY_VID = 0x054C,
|
66
|
+
YULONG_COOLPAD_VID = 0x1EBF
|
67
|
+
]
|
68
|
+
|
69
|
+
# Accessory Protocol allowed product ids
|
70
|
+
GOOGLE_PIDS = *(0x2d00..0x2d05)
|
71
|
+
|
72
|
+
## Accessory Protocol Commands
|
73
|
+
# Accessory Protocol "Get Protocol" command
|
74
|
+
COMMAND_GETPROTOCOL = 51
|
75
|
+
# Accessory Protocol "Send Id String" command
|
76
|
+
COMMAND_SENDSTRING = 52
|
77
|
+
# Accessory Protocol "Accessory Mode Start Up" commands
|
78
|
+
COMMAND_START = 53
|
79
|
+
|
80
|
+
# USB reenumeration delay in seconds
|
81
|
+
REENUMERATION_DELAY = 1
|
82
|
+
|
83
|
+
end
|
data/lib/ligo/context.rb
ADDED
@@ -0,0 +1,50 @@
|
|
1
|
+
# -*- coding: utf-8; fill-column: 80 -*-
|
2
|
+
#
|
3
|
+
# Copyright (c) 2012 Renaud AUBIN
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
#
|
17
|
+
|
18
|
+
# TODO: Add a proper mention to libusb LGPL licensing since the following code
|
19
|
+
# is a derivative work of Lars Kanis LIBUSB::Context.
|
20
|
+
|
21
|
+
module Ligo
|
22
|
+
|
23
|
+
class Context < LIBUSB::Context
|
24
|
+
include LIBUSB
|
25
|
+
|
26
|
+
def device_list
|
27
|
+
pppDevs = FFI::MemoryPointer.new :pointer
|
28
|
+
size = Call.libusb_get_device_list(@ctx, pppDevs)
|
29
|
+
ppDevs = pppDevs.read_pointer
|
30
|
+
pDevs = []
|
31
|
+
size.times do |devi|
|
32
|
+
pDev = ppDevs.get_pointer(devi*FFI.type_size(:pointer))
|
33
|
+
# Use Ligo::Device instead of LIBUSB::Device
|
34
|
+
device = Ligo::Device.new(self, pDev)
|
35
|
+
if VENDOR_IDS.include?(device.idVendor)
|
36
|
+
begin
|
37
|
+
# Include only AOAP compatible devices
|
38
|
+
pDevs << device if device.aoap?
|
39
|
+
rescue LIBUSB::ERROR_ACCESS
|
40
|
+
# TODO: do something about this exception, log at least!
|
41
|
+
end
|
42
|
+
end
|
43
|
+
end
|
44
|
+
Call.libusb_free_device_list(ppDevs, 1)
|
45
|
+
pDevs
|
46
|
+
end
|
47
|
+
private :device_list
|
48
|
+
end
|
49
|
+
|
50
|
+
end
|