Illuminance - masaru-takano/DeviceConnect-Spec GitHub Wiki

概要

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

目次

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

種別

one-shot

概要

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

リクエスト

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

レスポンス

物理名 データ型 必須 説明
result integer Yes 0:正常応答
0以外:異常応答
product string Yes DeviceConnectシステムの名前。
illuminance float Yes 照度
照度センサーが検知した照度。単位はルクス(lx)。
version string Yes DeviceConnectシステムのバージョン名。
hmac string No レスポンスに対する署名。アプリケーション側から事前にHMACキーを共有されていた場合は必須。

レスポンスサンプル

{
  "result" : 0,
  "product" : "Example System",
  "version" : "1.0.0",
  "illuminance" : 240
}
⚠️ **GitHub.com Fallback** ⚠️