種類

概要

外部からのリクエスト

MODEクラウドから動画取得コマンドを受信すると、指定されたカメラからその時間および前後を含む動画を取得します。

センサーとの紐付け

同一のゲートウェイに接続されているセンサーの値がしきい値以上（または以下）となった場合に、指定されたカメラからその時間および前後を含む動画を取得します。

{

    "value": {

        "sensorModuleId": "0002:iCamera2-iCamera2FC9EB8",

        "operation": "captureVideo",

        "parameters": {

            "duration": 15

        },

        "expirationPeriod": 600000,

        "status": "pending"

    }

}

sensorModuleId

固定文字列”0002:”に続けてカメラのセットアップの際に指定したIDを指定してください。

operation

"captureVideo" （変更不要）

duration

取得したい動画の長さを秒で指定してください。

timestamp

（オプション、上記例では未使用）取得したい動画の時刻をRFC3339の日時文字列で指定してください。

unixMillis

（オプション、timestampと排他、上記例では未使用）取得したい動画の時刻をUnix Epochからのミリ秒で指定してください。

expirationPeriod

600000 （変更不要）

status

"pending" （変更不要）

End point

PUT /devices/{deviceId}/kv/{key}

Key

operateSensorModule:{コマンドID。任意の英数字。}

Value

上で作成したoperateSensorModule.json

$ export DEVICE_ID=35425 

$ export APIKEY=v1.ZHw

$ curl  -i -X 'PUT' -H "Content-Type: application/json" -H "authorization: ModeCloud $APIKEY" -d @operateSensorModule.json "https://api.tinkermode.com/devices/$DEVICE_ID/kv/operateSensorModule:test"

{

    "value": [{

        "sensorModuleId": "0130:d6f000bfb1b6f",

        "sensorType": "COUNT:0",

        "value": 0,

        "comparisonOperator": ">",

        "targetSensorModuleId": "0002:iCamera2-iCamera2FC9EB8",

        "customCommand": "captureVideo",

        "coolDownPeriod": 60000

    }]

}

sensorModuleId

Series IDのうち、ハイフンより前の文字列を指定してください。

sensorType

Series IDのうち、ハイフンより後ろを大文字で指定してください。

value

トリガーするしきい値を数字で入力してください。

comparisonOperator

">" または "<" を指定してください。 

targetSensorModuleId

固定文字列"0002:"につづけて、動画を取得するカメラのIDを指定してください。

customCommand

"captureVideo" （変更不要）

coolDownPeriod

ミリ秒。一度トリガーした後は、この時間が経過するまでは同一のルールはトリガーされません。

End point

PUT /devices/{deviceId}/kv/{key}

Key

triggerConfig

Value

上で作成したtriggerConfig.json

$ export DEVICE_ID=35425 

$ export APIKEY=v1.ZHw

$ curl  -i -X 'PUT' -H "Content-Type: application/json" -H "authorization: ModeCloud $APIKEY" -d @triggerConfig.json "https://api.tinkermode.com/devices/$DEVICE_ID/kv/triggerConfig"

$ export DEVICE_ID=35425 

$ export APIKEY=v1.ZHw

$ curl  -i -X 'DELETE' -H "Content-Type: application/json" -H "authorization: ModeCloud $APIKEY" "https://api.tinkermode.com/devices/$DEVICE_ID/kv/triggerConfig"

URL

MODE側の動画リクエスト用エンドポイントを指定してください。

例)

https://api.tinkermode.com/devices/35425/kv/operateSensorModule:Actcast

Device ID(35425)は変更してください。

Method

PUT

Headers : Content-Type

application/json

Headers : authorization

Add Itemで”authorization”を追加してください。 

固定文字列“ModeCloud”の後ろに1つスペースを開けて、MODEプロジェクトのAPI Keyを指定してください。デバイスのAPI Keyでは動作しません。

Body

以下の内容を設定してください。durationには取得したい動画の長さ（秒）を指定してください。

{

  "value": {

    "sensorModuleId": "0002:{{ device.name }}",

    "operation": "captureVideo",

    "parameters": {

      "unixMillis": {{ detected_at }},

      "duration": 15

    },

    "expirationPeriod": 600000,

    "status": "pending"

  }

}