Hubkitは受信したデータをサードパーティのサーバーに送信するためのAPIエンドポイントのセットを提供します。
サードパーティのサーバはHubKitにデータを受信(サブスクライブ)するエンドポイントを登録することで、HubKitはデータを受信するとすぐにそのデータをエンドポイントに送信します

API エンドポイント

HubKitが送信するデータはすべてPOSTによるJSON形式となります

例 )
データを受信(サブスクライブ)するurl "https://en5lqsyl9wsws.x.pipedream.net/"https://127.0.0.1:29443/readingSubscriber/subscribe に登録する場合には正しい Content-type: application/json; charset=utf-8 のヘッダを指定する必要があります

POST https://HubKitAddress:29443/readingSubscriber/subscribe データを受信(サブスクライブ)するurlを登録/再登録するAPI エンドポイント
POST https://HubKitAddress:29443/readingSubscriber/unsubscribe データを受信(サブスクライブ)するurlを削除するAPI エンドポイント
POST https://HubKitAddress:29443/readingSubscriber/isRunning データを受信(サブスクライブ)するurlが有効かを確認するAPI エンドポイント

データフォーマット

Hubkitが送信するデータフォーマットはGravio Studioの Data Viewer に表示されている形式とほぼ同じ形式です

AreaName string エリア名 例): “Area 1”
LayerName string レイヤー名 例): “Layer 3”
DeviceName string デバイス名(customかdefault)例): “EnOcean” (default) or “Door Sensor 1” (custom)
LayerType string カテゴリ名 例): “Gravio-Door-JP”
DataType string データタイプ 例): “Contact status”
SenderId string センサーのIDまたはMAC Address 例): “05-00-0A-3D”
Data object 受信データ(numberかstring形式) 例): “Contact open” (string) or 24.408 (number)
Timestamp string データを受信したISO 8601 形式の UTC 日時
DataId string データID(データ受信時に自動設定されるUUID)

APIの使用方法

サーバのデータを受信するエンドポイントを登録します
エンドポイントをまだ準備されていない場合には RequestBin.com を使用します

HubKitがセンサーデータを受信すると、エンドポイントでそのセンサーデータが受信できます

お役に立ちましたか?

はい いいえ
お役に立ちましたか
理由をお聞かせください
フィードバックありがとうございました