Artoo 是一个使用 Ruby 语言的机器人微框架。
Artoo 为机器人和物理计算提供了一个简单而强大的领域特定语言(DSL)。
想在机器人上使用 JavaScript 吗?请查看我们的姐妹项目 Cylon.js (http://cylonjs.com)
想用 Go 编程语言来驱动你的机器人吗?请查看我们的姐妹项目 Gobot (http://gobot.io)。
示例:
基础
使用 Firmata 协议的 Arduino,带有 LED 和按钮。
require 'artoo'
connection :arduino, :adaptor => :firmata, :port => '/dev/ttyACM0'
device :led, :driver => :led, :pin => 13
device :button, :driver => :button, :pin => 2
work do
on button, :push => proc {led.toggle}
end
Parrot ARDrone 2.0
require 'artoo'
connection :ardrone, :adaptor => :ardrone
device :drone, :driver => :ardrone
work do
drone.start
drone.take_off
after(25.seconds) { drone.hover.land }
after(30.seconds) { drone.stop }
end
模块化
你还可以编写更加模块化的面向类的代码,这允许你控制机器人集群:
require 'artoo/robot'
SPHEROS = ["4567", "4568", "4569", "4570", "4571"]
class SpheroRobot < Artoo::Robot
connection :sphero, :adaptor => :sphero
device :sphero, :driver => :sphero
work do
every(3.seconds) do
sphero.roll 90, rand(360)
end
end
end
robots = []
SPHEROS.each {|p|
robots << SpheroRobot.new(:connections =>
{:sphero =>
{:port => p}})
}
SpheroRobot.work!(robots)
支持的 Ruby 版本:Ruby 2.1、Ruby 2.0、Ruby 1.9.3、JRuby 1.7.4+ 和 Rubinius 2.1+
Rubinius 需要 1.9 模式,使用 rvm 以 1.9 模式安装 Rubinius
rvm get head && rvm install rbx-2.1.1 --1.9
Artoo 在概念上受到 Sinatra 的影响,并借鉴了其中的一些代码。
Artoo 提供了一个强大的基于 actor 的消息架构,可以支持完全多线程操作和高并发,只要它被执行的 Ruby 版本支持。这意味着你需要使用 JRuby 或 Rubinius 来获得最大的并发性。
在很大程度上,这是因为它建立在 Celluloid、Celluloid::IO 和 Reel 之上。
硬件支持:
Artoo 有一个可扩展的系统用于连接硬件设备。目前支持以下机器人和物理计算平台:
- Arduino <=> 适配器
- ARDrone <=> 适配器
- BeagleBone <=> 适配器
- Crazyflie <=> 适配器
- Digispark <=> 适配器
- Joystick <=> 适配器
- Keyboard <=> 适配器
- Leap Motion <=> 适配器
- OpenCV <=> 适配器
- Pebble <=> 适配器
- Raspberry Pi <=> 适配器
- Roomba <=> 适配器
- Spark Core <=> 适配器
- Sphero <=> 适配器
更多平台即将推出!
Artoo 还支持可以在多个硬件平台上工作的设备。
你有一些 Artoo 尚未支持的硬件吗?我们想帮助你,帮助我们,帮助他们!请联系我们...
入门:
安装
gem install artoo
然后安装你想使用的硬件所需的 gem。例如,如果你想集成 PS3 控制器来驾驶你的 ARDrone:
gem install artoo-joystick
gem install artoo-ardrone
如果你将使用套接字到串行通信(如果你将使用 JRuby 或 Rubinius 则需要),你就可以开始编程你的硬件了。
如果你想直接通过串行端口连接,并且使用的是 MRI,请安装 hybridgroup-serialport gem:
gem install hybridgroup-serialport
编写你的机器人代码:
现在你已经准备好编写自己的代码了。看看 examples 目录,那里有大量可以帮助你入门的代码。我们建议使用你喜欢的测试框架进行 TDR(测试驱动机器人开发)。
运行你的机器人:
ruby myrobot.rb
API:
Artoo 包含一个 RESTful API,用于查询在一个组内运行的任何机器人的状态,包括连接和设备状态,以及通过 websockets 的设备流数据。
要激活 API,请像这样使用 api
命令:
require 'artoo'
connection :loop
device :passthru
api :host => '127.0.0.1', :port => '4321'
work do
puts "Hello from the API running at #{api_host}:#{api_port}..."
end
一旦机器人或组开始工作,你就可以在指定的主机和端口查看主 API 页面。
测试驱动机器人开发:
Artoo 使得使用你喜欢的 Ruby 测试和模拟框架对你的机器人设备进行测试驱动开发(TDD)变得容易。
这里有一个使用 Minitest、Mocha 和 Timecop 的例子:
require './test_helper'
require './test_robot'
describe 'sphero' do
let(:robot) { Artoo::MainRobot.new }
let (:start) { Time.now }
before :each do
Timecop.travel(start)
robot.work
end
after :each do
Timecop.return
end
it 'has work to do every 3 seconds' do
robot.has_work?(:every, 3.seconds).wont_be_nil
end
it 'receives collision event' do
robot.expects(:contact)
robot.sphero.publish("collision", "clunk")
sleep 0.05
end
it 'must roll every 3 seconds' do
Timecop.travel(start + 3.seconds) do
robot.sphero.expects(:roll)
sleep 0.05
end
Timecop.travel(start + 6.seconds) do
robot.sphero.expects(:roll)
sleep 0.05
end
end
end
用于描述以下 Sphero 机器人:
require 'artoo'
connection :sphero, :adaptor => :sphero, :port => '127.0.0.1:4560'
device :sphero, :driver => :sphero
def contact(*args)
@contacts ||= 0
@contacts += 1
puts "Contact #{@contacts}"
end
work do
on sphero, :collision => :contact
every(3.seconds) do
sphero.roll 90, rand(360)
end
end
使用 Artoo 进行测试驱动机器人开发的完整示例仓库位于 https://github.com/hybridgroup/artoo-test-example
CLI
Artoo使用Gort http://gort.io 命令行界面(CLI),因此您可以直接从命令行访问重要功能。我们称之为"机器人运维",即"机器人的DevOps"。您可以扫描、连接、更新设备固件等!
Artoo还有自己的CLI,可以生成新的机器人或使用其控制台。
$ artoo
命令:
artoo console ROBOT # 使用Robi控制台运行机器人
artoo generate SUBCOMMAND ...ARGS # 生成新的机器人或适配器
artoo help [COMMAND] # 描述可用命令或特定命令
artoo install SUBCOMMAND ...ARGS # 安装实用程序
artoo start ROBOT # 运行机器人
artoo version # 显示当前版本
控制台:
Artoo包含一个基于Pry的控制台,允许您以交互方式调试和控制您的机器人。
$ artoo console ./examples/hello.rb
运行 robi ./examples/hello.rb 从 "."
I, [2013-07-03T17:11:35.793913 #5527] 信息 -- : 注册连接'loop'...
I, [2013-07-03T17:11:35.794939 #5527] 信息 -- : 准备工作...
robi> start
启动主机器人...
I, [2013-07-03T17:11:48.950888 #5527] 信息 -- : 初始化连接loop...
I, [2013-07-03T17:11:48.955804 #5527] 信息 -- : 开始工作...
I, [2013-07-03T17:11:48.956152 #5527] 信息 -- : 连接到'loop',端口'#<Artoo::Port:0xfea0>'...
robi> list
#<Artoo::MainRobot:0x100c0>
robi> hello
hello
hello
robi> stop
停止机器人...
robi> exit
D, [2013-07-03T17:12:04.413060 #5527] 调试 -- : 终止7个执行者...
D, [2013-07-03T17:12:04.414300 #5527] 调试 -- : 干净完成关闭
生成器
想要集成我们还没有Artoo支持的硬件设备吗?有一个生成器可以帮你!您可以轻松生成一个新的Artoo适配器骨架,帮助您开始。只需运行'artoo generate adaptor'命令,生成器就会创建一个新目录,其中包含您的新适配器gem所需的所有文件。
$ artoo generate adaptor awesome_device
创建artoo-awesome_device适配器...
创建 artoo-awesome_device
存在 artoo-awesome_device
创建 artoo-awesome_device/Gemfile
创建 artoo-awesome_device/LICENSE
创建 artoo-awesome_device/README.md
创建 artoo-awesome_device/Rakefile
创建 artoo-awesome_device/artoo-awesome_device.gemspec
创建 artoo-awesome_device/lib/artoo-awesome_device.rb
创建 artoo-awesome_device/lib/artoo-awesome_device/version.rb
创建 artoo-awesome_device/lib/artoo/adaptors/awesome_device.rb
创建 artoo-awesome_device/lib/artoo/drivers/awesome_device.rb
创建 artoo-awesome_device/test/adaptors/awesome_device_adaptor_test.rb
创建 artoo-awesome_device/test/drivers/awesome_device_driver_test.rb
创建 artoo-awesome_device/test/test_helper.rb
完成!
文档
查看我们的文档,了解如何使用Artoo的大量信息。
如果您想帮助我们完善网站上的一些文档,可以访问artoo.io分支,然后按照说明操作。
IRC
需要更多帮助?只是想说"你好"?欢迎访问我们的IRC频道freenode #artoo
贡献
- 所有补丁必须在Apache 2.0许可下提供
- 请在git中使用-s选项"签署"提交是您的工作,并且您是根据Apache 2.0许可提供的
- 向适当的分支提交Github Pull Request,最好在IRC中与我们讨论更改
- 我们将查看补丁,进行测试,并给您反馈
- 避免与合并内容一起进行微小的空白更改、重命名等。这些将由维护人员不时进行,但它们可能会使合并变得复杂,应该单独进行
- 注意保持现有的编码风格
- 为任何新的或更改的功能添加单元测试
- 所有pull请求应该是"快进"的
- 如果您的提交之后有其他提交,请使用"git rebase -i <new_head_branch>"
- 如果您有本地更改,可能需要使用"git stash"
- 关于git帮助,请参阅progit,这是一本很棒的(而且免费的)git书籍
(c) 2012-2016 The Hybrid Group