橋本商会

Arduino Firmata gemにdRubyを用いたプロセス間共有機能を標準で入れようと考えている。
マイコンを複数プロセスで共有して同時に使えると、実にコードが綺麗になってRubyらしくていいと思う。

ここで試している
share an arduino with dRuby · Issue #25 · shokai/arduino_firmata

Arduinoを複数プロセスで共有したい

Lindaで色々やっていると、センサーで色々値を取ったり、モーターを動かしたり、色々やりたくなる。

Arduinoを複数のプロセスで共有し、プログラムの密結合を解きアプリケーションごとに別のコードとして分けたい。

ハードウェアをネットワークに接続して複数のプロセスを起動し、色々なサービスを同時に走らせる時に、1つの仮想シリアルポートは1プロセスからしか同時アクセスできない問題がある。（Arduinoはいまだに仮想シリアルポートなのだ）

解決方法は2つで、Arduinoを複数使う。しかしこれは格好悪いし金もかかるし電気も食うから良くない。
もしくは1つのプログラム内でThreadを立てて、1プロセスで複数のアプリケーションを動かす方法があるけどこれも格好悪い。プログラムをアプリケーション毎にバージョン管理できない。

dRuby

dRubyはRubyに標準で付いている分散オブジェクトライブラリであり、複数プロセス間でオブジェクトが共有できてメソッド呼び出しもできる。
marshalされたオブジェクトがTCP上で飛んでいくらしい。$stdoutなんかも別プロセスに渡せる。
先日のRubyHirobaでのtoRubyの人たちによるワークショップでちょっと触った瞬間にArduino共有したいと思った。

実験

0.5秒間隔で13番ピンのLEDを点滅させるプログラムと、
0.1秒ごとにADコンバータでセンサーを読んで11番ピンにPWM出力するプログラムを1台のArduinoで同時に走らせた。

server.rb

require 'rubygems'

require 'arduino_firmata'

require 'drb/drb'



arduino = ArduinoFirmata.connect

DRb.start_service "druby://localhost:5010", arduino



loop do

  arduino.digital_write 13, true

  sleep 0.5

  arduino.digital_write 13, false

  sleep 0.5

end

client.rb

require 'drb/drb'



DRb.start_service



arduino = DRbObject.new_with_uri "druby://localhost:5010"



loop do

  ad = arduino.analog_read 0

  puts ad

  arduino.analog_write 11, ad/4

  sleep 0.1

end

すんなりと両方同時に1台のArduinoの上で動いた。というのも当たり前で、firmataはArduinoから逐次送られてくるinput系の値はRuby VM上のArduinoFirmataインスタンスに貯めておくし、write系は即時にシリアル通信で送られてArduinoの出力ピンに反映される。通信は全二重で行われるので複数プロセスが1台のArduinoにfirmataで同時にアクセスしても何も問題はない。

無理なのはlambda渡しでイベント登録してコールバック受ける arduino.on(:analog_read, &block) や arduino.on(:sysex, &block) で、これはしょうがないかもしれない。
常に使う機能では無いし。

問題

開いているポートを探す

普通、RubyでTCPSocketなどを使おうとするとportが開いていなかったら例外が発生するのだが、dRubyでstart_serviceするとそのまま開けてしまう。
他のプロセスにもdRubyのメッセージが行ってしまう。

先にTCPSocket開いてそのインスタンスをdRubyで使うとかしたい。

だれがサーバーになるか

普通に考えて最初にArduinoを開いた人がサーバーになるだろうけど、その人が強制終了したら全員死んでしまいます。

オプションでもいい気がしてきた

arduino = ArduinoFirmata.connect "デバイス名", :share => true

とかでいいかも

twiticonはこのblogの右上にも出しているtwitterアイコンのサービス。SinatraとHerokuで実装している。

Twitterアイコン画像のURLは超長いし、新しいアイコンをアップロードする毎に変わるのだが、twiticonを使うと

<img src="http://twiticon.herokuapp.com/shokai">

<img src="http://twiticon.herokuapp.com/shokai/mini">

などで埋め込めるようになる。gyazzなどで使っている。


Twitter API v1.0が終了したのだが、1.1ではprofile_image_urlのAPIが無くなった。
代わりにusers/showでprofile_image_urlが取得できるが、各種サイズのURLは無くnormalサイズだけ。

biggerやminiなどのサイズはprofile_image_urlの末尾を_normal.pngから_bigger.pngなどに置換すると得られる。

また、users/showは認証しないと読めなくなったので@shokai_twiticonというアカウントを作ってその権限でOAuthしている。


ソースコード
shokai/twiticon · GitHub
twitterなどの設定は全て環境変数で入れる。

twitterのoauth tokenを設定する必要があるので、取得するためのツールを bin/get_twitter_oauth_keys.rb に入れておいた。
使い方はREADMEに書いた

SinatraでGitHub OAuthするの続き

試しにGitHub認証して、成功したらリポジトリとGistの一覧を表示するだけのアプリを作ってHerokuに置いておいた
http://sinatra-github-oauth-sample.herokuapp.com/

ソースコード
shokai/sinatra-github-oauth-sample · GitHub


https://github.com/settings/applicationsからRegister new Applicationした
OAuthのコールバックは /auth.callback に来る。



右上からログインすると


一度GitHubに移動してから戻ってきて、GitHub APIが使われてリポジトリとGistの一覧が出てくる
右上にGitHubに登録したアイコンが表示される。


1. GitHub認証して（これはSinatraでGitHub OAuthするに書いた）
2. 乱数とMD5でセッションID作ってブラウザに渡して
3. memcachedにセッションIDをkeyにしてgithubの情報を入れておく（2週間でexpireする）
4. トップページでは、ログイン状態ならoauth tokenをoctokitに渡してGitHubからリポジトリ/Gist一覧を取得する（これはmemcacheで1時間保持する）

必要な時にmemcachedからユーザー情報を取り出せるhelperを書いた
libs/cache.rbとcontroller/auth.rbに処理を詰め込んであるので、この2つだけコピーすれば他のSinatraアプリにもGitHubログイン機能追加できるはず。

RackやSinatraのログイン系のプラグインを使っても良いかと思ったが、memcachedクライアントにpure rubyかつバイナリプロトコルサポートしているdalliを使いたかったのと、
1つのmemcachedのkeyにprefix付けてログイン情報とリポジトリ/Gist一覧を保存できるようにしたかったので自分で書いた libs/cache.rb に任せた。配列のようにアクセスするとkeyにprefixが付いて読み書きできて便利。

Webアプリに「GitHubで認証」ボタンを付けてログインさせる方法。

アプリを登録

https://github.com/settings/applications
からRegister new Applicationする。

ローカルで試すので、URLとコールバックURLはこうしておく

自分のアプリケーションのIDとsecret keyがもらえるのでメモしておく。（あとで使う）

OAuthする

ここに手順が書いてある。この通りにやればOAuthのtokenが手に入る。
OAuth | GitHub API
tokenが手に入れば、あとはoctokitなどにtokenを渡せばそのユーザーの権限でAPIを使わせてもらえる。


手順はおおまかに

1. GET https://github.com/login/oauth/authorize

ユーザーのWebブラウザをGETパラメータにアプリケーションID付けて上のURLにredirectする。
OAuthの承認画面が表示され、OKされればアプリ登録時に設定したURLにcallbackされる。

2. コールバックから”code”を取り出す。

callback URLに指定した通り、ユーザーのWebブラウザで http://localhost:5000/auth.callback が開かれる。
その時にGETパラメータで”code”が付いているので、実際のURLは
http://localhost:5000/auth.callback?code=1234abcd56
こうなる。
codeを取っておく。

3. POST https://github.com/login/oauth/access_token

Sinatraから上のURLにPOSTする。
“code”とアプリケーションIDとsecretをPOSTすると、ようやくOAuthのtokenが得られる。

4. tokenでOAuth認証

tokenで認証して、ようやく「この人がGitHub上でなんというアカウント名なのか」「持っているリポジトリ一覧」などが取得できるようになる。
ここからはoctokit使えばいいと思う。

なお1の時にscope（読み書き権限の詳細）やstate（クロスサイトリクエスト対策の文字列）を付ける事もできる。
無くても一応動く。

実装

起動前にRegister new Applicationした時に得たアプリケーションIDとsecretを環境変数に入れておく。

export GITHUB_APP_ID=a1b2cdef344565677asdf

export GITHUB_APP_SECRET=asdfhujikohujiko123456

あとはこのアプリを起動して、 /auth に移動させれば認証できる。

require "sinatra"

require "uri"

require "httparty"



get '/auth' do

  query = {

    :client_id => ENV["GITHUB_APP_ID"],

    :redirect_uri => "#{env['rack.url_scheme']}://#{env['HTTP_HOST']}/auth.callback",

  }.map{|k,v|

    "#{k}=#{URI.encode v}"

  }.join("&")

  redirect "https://github.com/login/oauth/authorize?#{query}"

end



get '/auth.callback' do

  code = params["code"]

  halt 400, "bad request (code)" if code.to_s.empty?



  ## get oauth token

  query = {

    :body => {

      :client_id => ENV["GITHUB_APP_ID"],

      :client_secret => ENV["GITHUB_APP_SECRET"],

      :code => code

    },

    :headers => {

      "Accept" => "application/json"

    }

  }

  res = HTTParty.post("https://github.com/login/oauth/access_token", query)

  halt 500, "github auth error" unless res.code == 200

  begin

    token = JSON.parse(res.body)["access_token"]  ## tokenを取得！

  rescue

    halt 500, "github auth error"

  end

  ## sessionに保存するなど自由に

  redirect '/'

end

取得したtokenはoctokitで使える。

require 'octokit'



client = Octokit::Client.new :oauth_token => token

user = client.user

user.avatar_url  # アイコン画像

aptのrbenvが0.3.0と古かったので

Ubuntu12.04にrbenvインストールして、crontabやdaemontoolsも設定した

と同じ手順で0.4.0をgitから入れた。
けどビルドに2時間以上かかったので、aptで1.9.3-p194を入れればいいと思う。


crontabや、foremanで書きだしたupstartも

/home/pi/.rbenv/shims/bundle exec ruby hogehoge.rb

で起動したら問題なく動いた。