Vibration - masaru-takano/DeviceConnect-Spec GitHub Wiki

概要

バイブレーション操作機能を提供するプロファイル。

目次

API 概要
PUT /gotapi/vibration/vibrate スマートデバイスに対してバイブレーション依頼を送る。
DELETE /gotapi/vibration/vibrate スマートデバイスに対してバイブレーション停止依頼を送る。

PUT /gotapi/vibration/vibrate

種別

one-shot

概要

スマートデバイスに対してバイブレーション依頼を送る。

リクエスト

物理名 データ型 必須 説明
serviceId string Yes サービスID。取得対象デバイス
pattern array(long) No バイブレーションのパターン。カンマ区切りで、震える、止まるを繰り返しバイブレーションする。カンマ区切りされていない場合は、そのms分バイブレーションする。省略された場合は、デバイス毎のMax値分バイブレーションする。デバイス毎にMax値が設定されていない場合は、500ms分バイブレーションする。
例) 100, 100, 100, 100

レスポンス

物理名 データ型 必須 説明
result integer Yes 処理結果
0: 正常応答
0以外: 異常応答
product string Yes DeviceConnectシステムの名前
version string Yes DeviceConnectシステムのバージョン名
hmac string No レスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}

DELETE /gotapi/vibration/vibrate

種別

one-shot

概要

スマートデバイスに対してバイブレーション停止依頼を送る。

リクエスト

物理名 データ型 必須 説明
serviceId string Yes サービスID。取得対象デバイス

レスポンス

物理名 データ型 必須 説明
result integer Yes 処理結果
0: 正常応答
0以外: 異常応答
product string Yes DeviceConnectシステムの名前
version string Yes DeviceConnectシステムのバージョン名
hmac string No レスポンスに対する署名
アプリケーション側から事前にHMACキーを共有されていた場合は必須。

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0"
}
Add a custom footer
⚠️ **GitHub.com Fallback** ⚠️