WebIOPi の REST API

WebIOPi の REST API

REST API は
httpプロトコルで
URLにパラメータをつけて相手先サーバーと通信する方式のことで
Ajax ではお馴染みの通信方法

JavaScript から WebIOPi のAPI に
httpリクエストを送信することで
Raspberry Pi のGPIOポートの制御ができる

詳しくは
https://code.google.com/p/webiopi/wiki/RESTAPI
を参考に

主なAPIとしては

Set GPIO function
これは GPIO ポートの入出力モードの設定

構文は
POST /GPIO/GPIO番号/function/方向

GPIO番号が設定したいGPIO番号
方向は in で入力 out で出力
pwm なら PWM出力になる
戻り値は設定した内容になる

例としては
POST GPIO/4/function/in

Set GPIO value
これは GPIO ポートに出力する

構文は
GET /GPIO/GPIO番号/value/値

GPIO番号が出力したいGPIO番号
値は
0なら low 出力
1なら high 出力
戻り値は設定した値

例としては
GET /GPIO/4/value/1

Get GPIO value
これはGPIOポートの状態を取得
構文は
GET /GPIO/GPIO番号/value
GPIO番号は取得したいGPIO番号
戻り値は設定したポートの値で 0 か 1 になる

例としては
GET /GPIO/25/value

Output PWM with a duty cycle ratio
これはGPIOポートにPWM出力をする
構文は
POST /GPIO/GPIO番号/pulseRatio/比率
GPIO番号は、出力したいGPIO番号
比率は0~1になり
50%なら 0.5 になる
例としては
POST /GPIO/18/pulseRation/0.5

Output PWM with a angle for servos
これはGPIOポートに接続したサーボモータを制御する
構文は
POST /GPIO/GPIO番号/pulseAngle/角度
GPIO番号は、出力したいGPIOポート番号
角度は0度から指定可能で
もし45度なら 45 で指定
例としては
POST /GPIO/18/pulseAngle/45

Get Full GPIO state/configuration
これは、すべての状態を取得する
構文は
GET /*
戻り値は JSON 形式になる
使用例もそのままで
GET /*

となる

基本的に、
取得ならGET
送信とか出力などは POST
となる

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です