GPIO Profile

目次

API	機能概要
GPIO Export API	出力/入力の種類を設定する。
GPIO Digital API GET	デジタルの入力。
GPIO Digital API PUT	デジタルの出力。HIGHを出力。
GPIO Digital API DELETE	デジタルの出力。LOWを出力。
GPIO Digital API POST	デジタルの出力。HIGH, LOWいずれかを出力
GPIO Analog API GET	アナログの入力。
GPIO Analog API POST	アナログの出力。PWMで出力。
GPIO Change Event API	定期的な値の取得。

機能概要

General Purpose Input/Output（汎用入出力）にアクセスする機能を提供するProfile。

参考API

WebGPIO Draft Specification
https://rawgit.com/browserobo/WebGPIO/master/index.html

GPIO Export API

インターフェース名称	Version	種別
GPIO Export API	1.0.0	同期I/F

概要

出力/入力の種類を設定する。

リクエスト

HTTPメソッド	URI
POST	/gotapi/gpio/export/pin番号

論理名	物理名	データ型	省略	設定値
サービスID	serviceId	string	-	取得対象スマートデバイス
モード	mode	number	-	設定するモード 0:デジタルIN, 1:デジタルOUT, 2:アナログIN, 3:アナログOUT

レスポンス

Content-Type	形式	HTTPステータス
application/json	JSON	200

論理名	物理名	データ型	省略	設定値
処理結果	result	number	-	0:正常応答 0以外:異常応答

リクエストサンプル

POST http://localhost:4035/gotapi/gpio/export/1

POSTデータ
servieId=localhost.dconnect.com&accessToken=xxxx&mode=1

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result": 0,
}

GPIO Digital API GET

インターフェース名称	Version	種別
GPIO Digital API GET	1.0.0	同期I/F

概要

指定されたPINからデジタル値 HIGH(1)またはLOW(1)を入力。

リクエスト

HTTPメソッド	URI
GET	/gotapi/gpio/digital/pin番号

論理名	物理名	データ型	省略	設定値
サービスID	serviceId	string	-	取得対象スマートデバイス

レスポンス

Content-Type	形式	HTTPステータス
application/json	JSON	200

論理名	物理名	データ型	省略	設定値
処理結果	result	number	-	0:正常応答 0以外:異常応答
属性値	value	number	-	PINの値、HIGH(1) or LOW(0)が返ってくる。

リクエストサンプル

GET http://localhost:4035/gotapi/gpio/digital/1?servieId=localhost.deviceconnect.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result": 0,
    "value": 1
}

GPIO Digital API PUT

インターフェース名称	Version	種別
GPIO Digital API PUT	1.0.0	同期I/F

概要

指定されたPINにデジタル値のHIGH(1)を出力。

リクエスト

HTTPメソッド	URI
PUT	/gotapi/gpio/digital/pin番号

論理名	物理名	データ型	省略	設定値
サービスID	serviceId	string	-	取得対象スマートデバイス

レスポンス

Content-Type	形式	HTTPステータス
application/json	JSON	200

論理名	物理名	データ型	省略	設定値
処理結果	result	number	-	0:正常応答 0以外:異常応答

リクエストサンプル

PUT http://localhost:4035/gotapi/gpio/digital/1

PUTデータ
servieId=localhost.dconnect.com&accessToken=xxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result": 0,
}

GPIO Digital API DELETE

インターフェース名称	Version	種別
GPIO Digital API DELETE	1.0.0	同期I/F

概要

指定されたPINにデジタル値のLOW(0)を出力。

リクエスト

HTTPメソッド	URI
DELETE	/gotapi/gpio/digital/pin番号

論理名	物理名	データ型	省略	設定値
サービスID	serviceId	string	-	取得対象スマートデバイス
API名	api	string	-	gotapi

レスポンス

Content-Type	形式	HTTPステータス
application/json	JSON	200

論理名	物理名	データ型	省略	設定値
処理結果	result	number	-	0:正常応答 0以外:異常応答

リクエストサンプル

DELETE http://localhost:4035/gotapi/gpio/digital/1?servieId=localhost.deviceconnect.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result": 0,
}

GPIO Digital API POST

インターフェース名称	Version	種別
GPIO Digital API POST	1.0.0	同期I/F

概要

指定されたPINにデジタル値のHIGH(1)またはLOW(0)を出力。

リクエスト

HTTPメソッド	URI
POST	/gotapi/gpio/digital/pin番号

論理名	物理名	データ型	省略	設定値
サービスID	serviceId	string	-	取得対象スマートデバイス
値	value	number	-	出力する値 LOW(0), HIGH(1)

レスポンス

Content-Type	形式	HTTPステータス
application/json	JSON	200

論理名	物理名	データ型	省略	設定値
処理結果	result	number	-	0:正常応答 0以外:異常応答

リクエストサンプル

POST http://localhost:4035/gotapi/gpio/digital/1

POSTデータ
servieId=localhost.dconnect.com&accessToken=xxxx&value=1

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result": 0,
}

GPIO Analog API GET

インターフェース名称	Version	種別
GPIO Analog API GET	1.0.0	同期I/F

概要

指定されたPINのアナログ値を入力。

リクエスト

HTTPメソッド	URI
GET	/gotapi/gpio/analog/pin番号

論理名	物理名	データ型	省略	設定値
サービスID	serviceId	string	-	取得対象スマートデバイス

レスポンス

Content-Type	形式	HTTPステータス
application/json	JSON	200

論理名	物理名	データ型	省略	設定値
処理結果	result	number	-	0:正常応答 0以外:異常応答
値	value	number	-	指定したPINのアナログ値

リクエストサンプル

GET http://localhost:4035/gotapi/gpio/analog/1?servieId=localhost.deviceconnect.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result": 0,
    "value": 1024,
}

GPIO Analog API POST

インターフェース名称	Version	種別
GPIO Analog API GET	1.0.0	同期I/F

概要

指定されたPINのアナログ値を出力。

リクエスト

HTTPメソッド	URI
POST	/gotapi/gpio/analog/pin番号

論理名	物理名	データ型	省略	設定値
サービスID	serviceId	string	-	取得対象スマートデバイス
値	value	number	-	出力するアナログ値

レスポンス

Content-Type	形式	HTTPステータス
application/json	JSON	200

論理名	物理名	データ型	省略	設定値
処理結果	result	number	-	0:正常応答 0以外:異常応答

リクエストサンプル

POST http://localhost:4035/gotapi/gpio/analog/1

POSTデータ
servieId=localhost.dconnect.com&accessToken=xxxx&value=144

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result": 0,
}

GPIO Change Event API

インターフェース名称	Version	種別
GPIO Change Event API	1.0.0	非同期I/F(イベントI/F)

概要

各PINで、入力状態のモードに設定されているPINの値を定期的に送信する。

イベント情報

イベント名	Content-Type
/gotapi/gpio/onchange	application/json

メッセージ

<td>オブジェクト</td>
<td colspan="2" text-align="center">pins</td>
<td>object</td>
<td>-</td>
<td>各PINの配列</td>

論理名	物理名		データ型	省略	設定値

メッセージサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "servieId":  "device1.localhost.deviceconnect.org",
    "profile" : "gpio",
    "attribute" : "onchange",
    "sessionKey" : "0a93ac0aade4e046ed63eb24d1172f5f35c88ca60daa901547c28d5827cb418a5de1d7c5f9e62405",
    "pins" : {
        "14": 1023,
        "15": 111,
        "16": 201,
        "17": 0,
        "18": 1014,
        "19": 99,
    }
}