Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hybridgroup/artoo

Ruby framework for robotics, drones, and the Internet of Things (IoT)
https://github.com/hybridgroup/artoo

Last synced: about 1 month ago
JSON representation

Ruby framework for robotics, drones, and the Internet of Things (IoT)

Awesome Lists containing this project

README 

        
[![Artoo](https://cdn.rawgit.com/hybridgroup/artoo-site/master/source/images/elements/artoo.png)](http://artoo.io)



http://artoo.io/



Artoo is a micro-framework for robotics using Ruby.



Artoo provides a simple, yet powerful Domain-Specific Language (DSL) for robotics and physical computing.



Want to use JavaScript on robots? Check out our sister project Cylon.js (http://cylonjs.com)



Want to use the Go programming language to power your robots? Check out our sister project Gobot (http://gobot.io).



[![Code Climate](https://codeclimate.com/github/hybridgroup/artoo.png)](https://codeclimate.com/github/hybridgroup/artoo) [![Build Status](https://travis-ci.org/hybridgroup/artoo.png?branch=master)](https://travis-ci.org/hybridgroup/artoo)



## Examples:



### Basic



#### Arduino with an LED and a button, using the Firmata protocol.



```ruby

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



```ruby

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

```



### Modular



You can also write more modular class-oriented code, that allows you to control swarms of robots:



```ruby

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 versions supported: Ruby 2.1, Ruby 2.0, Ruby 1.9.3, JRuby 1.7.4+, and Rubinius 2.1+



Rubinius requires 1.9 mode, to install Rubinius in 1.9 mode using rvm



```

rvm get head && rvm install rbx-2.1.1 --1.9

```



Artoo is conceptualy influenced by [Sinatra](https://github.com/sinatra/sinatra) as well as borrowing some code from it.



Artoo provides a robust actor-based messaging architecture, that can support fully multi-threaded operation and high-concurrency, as long as it is supported by the Ruby version in which it is executing. This means you will need to use JRuby or Rubinius for maximum concurrency.



To a large extent, this is due to being built on top of [Celluloid](https://github.com/celluloid/celluloid), [Celluloid::IO](https://github.com/celluloid/celluloid-io), and [Reel](https://github.com/celluloid/reel).



## Hardware support:



Artoo has a extensible system for connecting to hardware devices. The following robotics and physical computing platforms are currently supported:



  - [Arduino](http://www.arduino.cc/) <=> [Adaptor](https://github.com/hybridgroup/artoo-arduino)

  - [ARDrone](http://ardrone2.parrot.com/) <=> [Adaptor](https://github.com/hybridgroup/artoo-ardrone)

  - [BeagleBone](http://beagleboard.org/) <=> [Adaptor](https://github.com/hybridgroup/artoo-beaglebone)

  - [Crazyflie](http://www.bitcraze.se/) <=> [Adaptor](https://github.com/hybridgroup/artoo-crazyflie)

  - [Digispark](http://digistump.com/products/1) <=> [Adaptor](https://github.com/hybridgroup/artoo-digispark)

  - [Joystick](http://www.libsdl.org/) <=> [Adaptor](https://github.com/hybridgroup/artoo-joystick)

  - [Keyboard](http://en.wikipedia.org/wiki/Computer_keyboard) <=> [Adaptor](https://github.com/hybridgroup/artoo-keyboard)

  - [Leap Motion](https://www.leapmotion.com/) <=> [Adaptor](https://github.com/hybridgroup/artoo-leapmotion)

  - [OpenCV](http://opencv.org/) <=> [Adaptor](https://github.com/hybridgroup/artoo-opencv)

  - [Pebble](http://getpebble.com/) <=> [Adaptor](https://github.com/hybridgroup/artoo-pebble)

  - [Raspberry Pi](http://www.raspberrypi.org/) <=> [Adaptor](https://github.com/hybridgroup/artoo-raspi)

  - [Roomba](http://www.irobot.com/About-iRobot/STEM.aspx) <=> [Adaptor](https://github.com/hybridgroup/artoo-roomba)

  - [Spark Core](http://www.spark.io/) <=> [Adaptor](https://github.com/hybridgroup/artoo-spark)

  - [Sphero](http://www.gosphero.com/) <=> [Adaptor](https://github.com/hybridgroup/artoo-sphero)



More platforms are coming soon!



Artoo also has support for devices that can work across multiple hardware platforms.

  - GPIO (General Purpose Input/Output) devices <=> [Drivers](https://github.com/hybridgroup/artoo-gpio)

  - i2c devices <=> [Drivers](https://github.com/hybridgroup/artoo-i2c)



Do you have some hardware that is not yet supported by Artoo? We want to help you, help us, help them! Get in touch...



## Getting Started:



### Installation



```ruby

gem install artoo

```



Then install the gems required by the hardware you want to use. For example, if you wanted to integrate a PS3 controller to fly your ARDrone:



```ruby

gem install artoo-joystick

gem install artoo-ardrone

```



If you will be using socket to serial commuication (required if you will use JRuby or Rubinius), you are ready to start programming your hardware.



If you want to connect via serial port directly, and are using MRI, install the hybridgroup-serialport gem:



```ruby

gem install hybridgroup-serialport

```



### Writing your robot code:



Now you are ready to write your own code. Take a look at the examples directory for a whole bunch of code you can use to help get started. We recommend using TDR (Test-Driven Robotics) with your preferred test frameworks.



### Running your robot:



```ruby

ruby myrobot.rb

```



## API:



Artoo includes a RESTful API to query the status of any robot running within a group, including the connection and device status, and device streaming data via websockets.



To activate the API, use the `api` command like this:



```ruby

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

```



Once the robot or group is working, you can view the main API page at the host and port specified.



## Test-Driven Robotics:



Artoo makes it easy to do Test Driven Development (TDD) of your robotic devices using your favorite Ruby test and mocking frameworks.



Here is an example that uses Minitest, Mocha, and Timecop:



```ruby

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

```

to describe the following Sphero robot:



```ruby

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

```



The repo with full example of using Artoo for test driven robotics is located at [https://github.com/hybridgroup/artoo-test-example](https://github.com/hybridgroup/artoo-test-example)



## CLI



Artoo uses the Gort [http://gort.io](http://gort.io) Command Line Interface (CLI) so you can access important features right from the command line. We call it "RobotOps", aka "DevOps For Robotics". You can scan, connect, update device firmware, and more!



Artoo also has its own CLI so you can generate new robots, or use its console.



```

$ artoo

Commands:

  artoo console ROBOT                # Run a robot using the Robi console

  artoo generate SUBCOMMAND ...ARGS  # Generates a new robot or adaptor

  artoo help [COMMAND]               # Describe available commands or one specific command

  artoo install SUBCOMMAND ...ARGS   # Installs utility programs

  artoo start ROBOT                  # Run a robot

  artoo version                      # Displays the current version

```



### Console:



Artoo includes a console based on [Pry](http://pryrepl.org/) to allow you to interactively debug and control your robot.



```

$ artoo console ./examples/hello.rb

         run  robi ./examples/hello.rb from "."

I, [2013-07-03T17:11:35.793913 #5527]  INFO -- : Registering connection 'loop'...

I, [2013-07-03T17:11:35.794939 #5527]  INFO -- : Preparing work...

robi> start

Starting main robot...

I, [2013-07-03T17:11:48.950888 #5527]  INFO -- : Initializing connection loop...

I, [2013-07-03T17:11:48.955804 #5527]  INFO -- : Starting work...

I, [2013-07-03T17:11:48.956152 #5527]  INFO -- : Connecting to 'loop' on port '#'...

robi> list

#

robi> hello

hello

hello

robi> stop

Stopping robots...

robi> exit

D, [2013-07-03T17:12:04.413060 #5527] DEBUG -- : Terminating 7 actors...

D, [2013-07-03T17:12:04.414300 #5527] DEBUG -- : Shutdown completed cleanly

```



### Generator



Want to integrate a hardware device we don't have Artoo support for yet? There's a generator for that! You can easily generate a new skeleton Artoo adaptor to help you get started. Simply run the 'artoo generate adaptor' command, and the generator will create a new directory with all of the files in place for your new adaptor gem.



```

$ artoo generate adaptor awesome_device

Creating artoo-awesome_device adaptor...

      create  artoo-awesome_device

       exist  artoo-awesome_device

      create  artoo-awesome_device/Gemfile

      create  artoo-awesome_device/LICENSE

      create  artoo-awesome_device/README.md

      create  artoo-awesome_device/Rakefile

      create  artoo-awesome_device/artoo-awesome_device.gemspec

      create  artoo-awesome_device/lib/artoo-awesome_device.rb

      create  artoo-awesome_device/lib/artoo-awesome_device/version.rb

      create  artoo-awesome_device/lib/artoo/adaptors/awesome_device.rb

      create  artoo-awesome_device/lib/artoo/drivers/awesome_device.rb

      create  artoo-awesome_device/test/adaptors/awesome_device_adaptor_test.rb

      create  artoo-awesome_device/test/drivers/awesome_device_driver_test.rb

      create  artoo-awesome_device/test/test_helper.rb

Done!

```



## Documentation



Check out our [documentation](http://artoo.io/documentation/) for lots of information about how to use Artoo.



If you want to help us with some documentation on the site, you can go to [artoo.io branch](https://github.com/hybridgroup/artoo/tree/artoo.io) and then, follow the instructions.



## IRC



Need more help? Just want to say "Hello"? Come visit us on IRC freenode #artoo



## Contributing

* All patches must be provided under the Apache 2.0 License

* Please use the -s option in git to "sign off" that the commit is your work and you are providing it under the Apache 2.0 License

* Submit a Github Pull Request to the appropriate branch and ideally discuss the changes with us in IRC.

* We will look at the patch, test it out, and give you feedback.

* Avoid doing minor whitespace changes, renamings, etc. along with merged content. These will be done by the maintainers from time to time but they can complicate merges and should be done seperately.

* Take care to maintain the existing coding style.

* Add unit tests for any new or changed functionality.

* All pull requests should be "fast forward"

  * If there are commits after yours use “git rebase -i ”

  * If you have local changes you may need to use “git stash”

  * For git help see [progit](http://git-scm.com/book) which is an awesome (and free) book on git



(c) 2012-2016 The Hybrid Group