Illuminance - TakayukiHoshi1984/DeviceConnect-Spec GitHub Wiki

概要

スマートデバイスが計測した照度を取得する機能を提供するAPI。

目次

API 概要
GET /gotapi/illuminance スマートデバイスの照度を取得する機能を提供する。

GET /gotapi/illuminance

種別

one-shot

概要

スマートデバイスの照度を取得する機能を提供する。

照度の値はデバイスプラグイン側で0.0〜1.0の範囲に正規化して返すこと。

リクエスト

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

レスポンス

論理名 物理名 データ型 必須 説明
処理結果 result integer Yes 0:正常応答
0以外:異常応答
システム名 product string Yes DeviceConnectシステムの名前。
システムバージョン version string Yes DeviceConnectシステムのバージョン名。
署名 hmac string No レスポンスに対する署名。 アプリケーション側から事前にHMACキーを共有されていた場合は必須。
照度 illuminance float Yes 照度センサーが検知した照度。単位はルクス(lx)。
照度のタイムスタンプ timeStamp long No 測定が行われた測定時間。ミリ秒のUnixタイムスタンプで返す。
照度のタイムスタンプ文字列 timeStampString dateTime No タイムスタンプと同じタイムスタンプを RFC3339「yyyy-MM-dd''T''HH:mm:ssZZZZZ」の形式で返す。

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "illuminance" : 240,
  "timeStamp" : 1431856940275,
  "timeStampString" : "2015-05-17T10:02:20+09:00"
}
Add a custom footer
⚠️ **GitHub.com Fallback** ⚠️