API コマンド仕様書
BraveGATE 対応

REV 1.0

BraveGATE 体感キット
FBV-BGRT-EK
DESIGNED BY Braveridge Co., Ltd.

Braveridge Co., Ltd.

1

内容(目次)１ コマンド仕様
1.1.

BraveGATE 利用時のコマンド仕様 ........................................................................................ 3

1.2.

センサーID について ........................................................................................................... 4

1.3.

即時 Uplink 要求 ............................................................................................................ 4

1.4.

スケジュール機能 .............................................................................................................. 6

1.4.1.

定期アップリンクの間隔を指定する機能

6

1.4.2.

定期アップリンクを停止する機能

8

1.4.3.

定期アップリンクを再開する機能

9

2.

3.

3

センサーデータアップリンク仕様

10

2.1.

温度センサーデータ仕様 ..................................................................................................... 102.2.

湿度センサーデータ仕様 ..................................................................................................... 122.3.

照度センサーデータ仕様 ..................................................................................................... 142.4.

加速度センサーデータ仕様 .................................................................................................. 162.5.

電池残量センサーデータ仕様 ............................................................................................... 18
商標について20

Braveridge Co., Ltd.

2

１コマンド仕様
1.1.

BraveGATE 利用時のコマンド仕様

BraveGATEクラウドサービスを使用してBraveROUTE(BLEルーター)対してダウンリンク命令を送信する機能を提供します。 この章では、BraveGATE APIに送信するダウンリンク命令のJSON形式コマンドパラメータについて説明します。
各IDのサイズについては以下と定義されています。
値名

サイズ

説明

device_id

16桁(HEX表記, case-sensitive)

deviceに割当たっている固有のID

router_id

8桁(HEX表記, case-sensitive)

routerに割当たっている固有のID

sensor_id

4桁(HEX表記, case-sensitive)

sensorの種別に割当たっている固有のID

group id

GRを接頭語とする英数字32桁

groupに割当たっている固有のID

application_id

APを接頭語とする英数字32桁

applicationに割当たっている固有のID

uplink_id

汎用一意識別子（UUID）

8桁-4桁-4桁-4桁-12桁で構成される、uplinkのセンサ

小文字の16進数表記桁とハイフンでーデータに紐付けられる一意のID。

構成される36桁
API の詳細仕様については下記のサイトを参照してください
http://developer.braveridge.io/docs/api/v1/index.html
また、API の具体的な使用方法については、「BraveGATE CORE ユーザーズガイド」を参照ください

Braveridge Co., Ltd.

3

1.2.

センサーID について

本デバイスに搭載されているセンサーについて、コマンドにて指定するセンサーID については、以下となります。
センサー名

センサーID説明

温度センサー

0004

温度を計測します。(摂氏)

湿度センサー0005

相対湿度を測定します (0-100%)

照度センサー

0007

照度を測定します。(ルクス)

振動センサー

0015

加速度を測定し、動いているか静止しているかを判別します。

電池残量センサー

0033

電池の残量を測定します。(%)

1.3.

即時 Uplink 要求

指定したセンサーの測定値のアップリンク要求を行います。
NOTE
本デバイスでは、どのセンサーを指定しても、温度、湿度、照度、バッテリー、振動センサーの値のアップリンクを行います。振動センサーに関しては、トリガ値ではなく、現在のステータス(動いているか、静止しているかの状態)の値をアップリンクします。
即時アップリンクリクエストパラメーター
JSON KEY

値

必須

説明

name

String◎

SEND_DATA_AT_ONCE

targetObject◎Array(String)○

devices

送り先の device id
複数指定可(最大 100)
devices もしくは groups が必須

groupsArray(String)○

送り先の group id
複数指定可 (group に所属するルーターは 100以下にしてください。)
devices もしくは groups が必須

paramssensor_id

Object◎String◎0004, 0005, 0007, 0015, 0033 のいずれかを指定します。(どのセンサーID を指定しても、同じ動作となります。)

Body の例)
POST /commands{"name": "SEND_DATA_AT_ONCE","targets": {"devices": ["2468800108000001","2468800108000002","2468800108000003"]"groups": ["GR0123456789abcdefghijkABCDEFGHIJK",
Braveridge Co., Ltd.

4

"GR0000000000xxxxxxxxxxxXXXXXXXXXXX"]},"params": {"sensor_id": "0004"}}

Braveridge Co., Ltd.

5

スケジュール機能

1.4.

本デバイスはカスタマイズにより、スケジュール機能を実装しています。
1.

定期アップリンクの間隔を指定する機能

2.

定期アップリンクを停止する機能

3.

定期アップリンクを再開する機能を実装しています。
スケジュール機能の指定は、温度センサー、湿度センサー、照度センサー、電池残量センサーの定期アップリンクに有効となります。
振動センサーについては、停止、再開する機能の設定にかかわらず常に動作します。

NOTE
BraveGATE の通常の一定間隔指定では、SET_UPLINK_INTERVAL コマンドを使用しますが、デバイス特有の機能を迅速に開発するために、バイナリベースでのコマンド、データを送受信できる汎用コマンドにて実装するこも可能です。本デバイスのカスタマ
イズは、このバイナリーでの送受信の汎用コマンド、汎用センサー機能を利用して実装されています。
定期アップリンクの間隔を指定する機能

1.4.1.

温度センサー、湿度センサー、照度センサー、電池残量センサーのセンターデーターを指定した一定間隔毎にアップリンクします。
定期アップリンクコマンドリクエストパラメーター
JSON KEY

値

必須

説明

name

String◎

SET_UPLINK_INTERVAL

targetObject◎Array(String)○

devices

送り先の device id
複数指定可(最大 100)
devices もしくは groups が必須

groupsArray(String)○

送り先の group id
複数指定可 (group に所属するルーターは 100以下にしてください。)
devices もしくは groups が必須

paramssensor_id

Object◎String◎0004, 0005, 0007, 0033 のいずれかを指定します。(どのセンサーID を指定しても、同じ動作となります。)

interval

Number◎

定期アップリンクの間隔を秒数で指定します。(103600)

Body の例)
POST /commands{"name": "SET_UPLINK_INTERVAL","targets": {"devices": [Braveridge Co., Ltd.

6

"2468800108000001","2468800108000002","2468800108000003"]"groups": ["GR0123456789abcdefghijkABCDEFGHIJK","GR0000000000xxxxxxxxxxxXXXXXXXXXXX"]},"params": {"sensor_id": "0004","interval”: 60}}

Braveridge Co., Ltd.

7

1.4.2. 定期アップリンクを停止する機能
温度センサー、湿度センサー、照度センサー、電池残量センサーのセンターデーターの定期アップリンクを停止します。
定期アップリンクコマンドリクエストパラメーター
JSON KEY

値

必須

説明

name

String◎

SET_UPLINK_DISABLE

targetObject◎Array(String)○

devices

送り先の device id
複数指定可(最大 100)
devices もしくは groups が必須

groupsArray(String)○

送り先の group id
複数指定可 (group に所属するルーターは 100以下にしてください。)
devices もしくは groups が必須

paramssensor_id

Object◎String◎0004, 0005, 0007, 0033 のいずれかを指定します。(どのセンサーID を指定しても、同じ動作となります。)

Body の例)
POST /commands{"name": "SET_UPLINK_DISABLE","targets": {"devices": ["2468800108000001","2468800108000002","2468800108000003"]"groups": ["GR0123456789abcdefghijkABCDEFGHIJK","GR0000000000xxxxxxxxxxxXXXXXXXXXXX"]},"params": {"sensor_id": "0004"}}

Braveridge Co., Ltd.

8

定期アップリンクを再開する機能

1.4.3.

温度センサー、湿度センサー、照度センサー、電池残量センサーのセンターデーターの定期アップリンクを再開します。
再開後の定期アップリンクの間隔については、最後に指定した時間間隔の値となります。
定期アップリンクコマンドリクエストパラメーター
JSON KEY

値

必須

説明

name

String◎

SET_UPLINK_ENABLE

targetObject◎Array(String)○

devices

送り先の device id
複数指定可(最大 100)
devices もしくは groups が必須

groupsArray(String)○

送り先の group id
複数指定可 (group に所属するルーターは 100以下にしてください。)
devices もしくは groups が必須

paramssensor_id

Object◎String◎0004, 0005, 0007, 0033 のいずれかを指定します。(どのセンサーID を指定しても、同じ動作となります。)

Body の例)
POST /commands{"name": "SET_UPLINK_ENABLE","targets": {"devices": ["2468800108000001","2468800108000002","2468800108000003"]"groups": ["GR0123456789abcdefghijkABCDEFGHIJK","GR0000000000xxxxxxxxxxxXXXXXXXXXXX"]},"params": {"sensor_id": "0004"}}

Braveridge Co., Ltd.

9

2. センサーデータアップリンク仕様
デバイスのセンサーデータは、あらかじめ設定したwebhook先のURLにBraveGATE COREからJSONデータ
がPOSTされます。 (体感キットについては、予めwebhook先のアプリケーションとして弊社デモサイトが登録されています。)
本体感キットのデバイスについては、個々のセンサーデータをそれぞれ個別にアップリンクします。
2.1.

温度センサーデータ仕様

温度センサーの JSON データ仕様を以下に示します。
温度センサーJSON データ仕様
JSON KEY

値

必須

説明

group

Object○group_id

String○アプリケーションが属しているグループID

name

String○グループの登録名(ユーザー定義にて設定された値)

application

Object○application_id

String○

登録したアプリケーションのアプリケーションID

name

String○アプリケーションの登録名(ユーザー定義にて設定された値)

router○router_id

String○デバイスのセンサーデータを送信したルーターID

imsi

String○ルーター内蔵SIMの加入者識別番号

rssi

Number○

ルーターがLTE基地局から受信している電波強度

battery

Number○

ルーター搭載のバッテリー値(0～100)

fw_version

String○

ルーターのFirmware バージョン(最大11桁)

Object○device_id

String○センサーデータを送信したデバイスID

sensor_id

String○温度センサーのID “0004”

sensor_name

String○温度センサーを表すTemperature sensor “のdevice文字列（固定文字列）
rssi

number○

ルーターが受信しているBLEデバイスの電波強度(0～-120)

data

Object○デバイスのセンサーデータのオブジェクト

Number○

温度 (摂氏)uplink_id

String○センサーデータのアップリンク処理の一意のID

date

String○

ルーターがセンサーデータを受信した日付(ISOtemperature8601) 25桁

Braveridge Co., Ltd.

10例）温度センサーの JSON データ{"group": {"group_id": "GRXJpWIo4BWbD1AurWJMKo6Fx2qr7njBmz","name": ""},"application": {"application_id": "APjmDyv2Y7ZomGPEXs5rccqtiVsaIAqOoT","name": "DemoApp"},"router": {"router_id": "000001be","imsi": "440030011066385","rssi": -51,
"battery": 61,"fw_version": "136.2.8"},"device": {"device_id": "2468800108000001","sensor_id": "0004","sensor_name": "Temperature sensor","rssi": -26,
"data": {"temperature": 29.91}},"uplink_id": "053e61b7-ca2e-47a8-9396-7f34534e557f","date": "2020-06-12T17:57:12+09:00"}

Braveridge Co., Ltd.

11

2.2.

湿度センサーデータ仕様

湿度センサーの JSON データ仕様を以下に示します。
湿度センサーJSON データ仕様
JSON KEY

値

必須

説明

group

Object○group_id

String○アプリケーションが属しているグループID

name

String○グループの登録名(ユーザー定義にて設定された値)

application

Object○application_id

String○

登録したアプリケーションのアプリケーションID

name

String○アプリケーションの登録名(ユーザー定義にて設定された値)

router○router_id

String○デバイスのセンサーデータを送信したルーターID

imsi

String○ルーター内蔵SIMの加入者識別番号

rssi

Number○

ルーターがLTE基地局から受信している電波強battery

Number○

ルーター搭載のバッテリー値(0～100)

fw_version

String○

ルーターのFirmware バージョン(最大11桁)

Object○device_id

String○センサーデータを送信したデバイスID

sensor_id

String○

湿度センサーのID “0005”

sensor_name

String○

湿度センサーを表す”Humidity sensor “の文度

device字列（固定文字列）
rssi

number○

ルーターが受信しているBLEデバイスの電波強度(0～-120)

data

Object○デバイスのセンサーデータのオブジェクト

Float

○

相対湿度 (0-100、小数部の桁数２)

uplink_id

String○センサーデータアップリンク処理の一意のID

date

String○

ルーターがセンサーデータを受信した日付(ISOhumidity

8601) 25桁

Braveridge Co., Ltd.

12例）湿度センサーの JSON データ{"group": {"group_id": "GRXJpWIo4BWbD1AurWJMKo6Fx2qr7njBmz","name": ""},"application": {"application_id": "APjmDyv2Y7ZomGPEXs5rccqtiVsaIAqOoT","name": "DemoApp"},"router": {"router_id": "000001be","imsi": "440030011066385","rssi": -51,
"battery": 61,"fw_version": "1.0.0"},"device": {"device_id": "2468800108000001","sensor_id": "0005","sensor_name": "Humidity sensor","rssi": -26,
"data": {"humidity": 59.58}},"uplink_id": "57ea7d3e-92e3-4b5e-85b2-d4a361ba318e","date": "2020-06-12T17:57:13+09:00"}

Braveridge Co., Ltd.

13

2.3.

照度センサーデータ仕様

照度センサーの JSON データ仕様を以下に示します。
照度センサーJSON データ仕様
JSON KEY

値

必須

説明

group

Object○group_id

String○アプリケーションが属しているグループID

name

String○グループの登録名(ユーザー定義にて設定された値)

application

Object○application_id

String○

登録したアプリケーションのアプリケーションID

name

String○アプリケーションの登録名(ユーザー定義にて設定された値)

router○router_id

String○デバイスのセンサーデータを送信したルーターID

imsi

String○ルーター内蔵SIMの加入者識別番号

rssi

Number○

ルーターがLTE基地局から受信している電波強度

battery

Number○

ルーター搭載のバッテリー値(0～100)

fw_version

String○

ルーターのFirmware バージョン(最大11桁)

Object○device_id

String○センサーデータを送信したデバイスID

sensor_id

String○照度センサーのID “0007”

sensor_name

String○照度センサーを表す” Illuminance sensor “のdevice文字列（固定文字列）
rssi

number○

ルーターが受信しているBLEデバイスの電波強度(0～-120)

data
lux

Object○デバイスのセンサーデータのオブジェクト

Float

○

照度(ルクス、float32の範囲内の正の数、小数部の桁数２)

uplink_id

String○センサーデータアップリンク処理の一意のID

date

String○

ルーターがセンサーデータを受信した日付(ISO8601) 25桁

Braveridge Co., Ltd.

14

例）照度センサーの JSON データ{"group": {"group_id": "GRXJpWIo4BWbD1AurWJMKo6Fx2qr7njBmz","name": ""},"application": {"application_id": "APjmDyv2Y7ZomGPEXs5rccqtiVsaIAqOoT","name": "DemoApp"},"router": {"router_id": "000001be","imsi": "440030011066385","rssi": -51,
"battery": 61,"fw_version": "1.0.0"},"device": {"device_id": "2468800108000001","sensor_id": "0005","sensor_name": "Illuminance sensor","rssi": -26,
"data": {"lux": 399.04}},"uplink_id": "57ea7d3e-92e3-4b5e-85b2-d4a361ba318e","date": "2020-06-12T17:57:13+09:00"}

Braveridge Co., Ltd.

15

2.4.

加速度センサーデータ仕様

加速度センサーの JSON データ仕様を以下に示します。
加速度センサーJSON データ仕様
JSON KEY

値

必須

説明

group

Object○group_id

String○アプリケーションが属しているグループID

name

String○グループの登録名(ユーザー定義にて設定された値)

application

Object○application_id

String○

登録したアプリケーションのアプリケーションID

name

String○アプリケーションの登録名(ユーザー定義にて設定された値)

router○router_id

String○デバイスのセンサーデータを送信したルーターID

imsi

String○ルーター内蔵SIMの加入者識別番号

rssi

Number○

ルーターがLTE基地局から受信している電波強度

battery

Number○

ルーター搭載のバッテリー値(0～100)

fw_version

String○

ルーターのFirmware バージョン(最大11桁)

Object○device_id

String○センサーデータを送信したデバイスID

sensor_id

String○

加速度センサーのID “0015”

sensor_name

String○

加速度センサーを表す“Move detection“の文

device字列 （固定文字列）
rssi

number○

ルーターが受信しているBLEデバイスの電波強度(0～-120)

data
move_info_flag

Object○デバイスのセンサーデータのオブジェクト

Number○

加速度センサーが２秒間うごき、静止10秒間したら、０。即時アップリンク時には現在の状態を示します。

Number○未実装 (現時点では、常に0）

uplink_id

String○センサーデータのアップリンク処理の一意のID

date

String○

ルーターがセンサーデータを受信した日付(ISOmove_info_count8601) 25桁

Braveridge Co., Ltd.

16例）加速度センサーの JSON データ{"group": {"group_id": "GRXJpWIo4BWbD1AurWJMKo6Fx2qr7njBmz","name": ""},"application": {"application_id": "APjmDyv2Y7ZomGPEXs5rccqtiVsaIAqOoT","name": "DemoApp"},"router": {"router_id": "000001be","imsi": "440030011066385","rssi": -53,
"battery": 94,"fw_version": "136.2.8"},"device": {"device_id": "2468800108000001","sensor_id": "0015","sensor_name": "Move detection","rssi": -19,
"data": {"move_info_flag": 1,"move_info_count": 0}},"uplink_id": "73c304ad-ed05-48b8-896c-82414a54017e","date": "2020-06-09T20:45:35+09:00"}

Braveridge Co., Ltd.

17

2.5.

電池残量センサーデータ仕様

電池残量センサーの JSON データ仕様を以下に示します。
電池残量センサーJSON データ仕様
JSON KEY

値

必須

説明

group

Object○group_id

String○アプリケーションが属しているグループID

name

String○グループの登録名(ユーザー定義にて設定された値)

application

Object○application_id

String○

登録したアプリケーションのアプリケーションID

name

String○アプリケーションの登録名(ユーザー定義にて設定された値)

router○router_id

String○デバイスのセンサーデータを送信したルーターID

imsi

String○ルーター内蔵SIMの加入者識別番号

rssi

Number○

ルーターがLTE基地局から受信している電波強度

battery

Number○

ルーター搭載のバッテリー値(0～100)

fw_version

String○

ルーターのFirmware バージョン(最大11桁)

Object○device_id

String○センサーデータを送信したデバイスID

sensor_id

String○

電池残量センサーのID “0033”

sensor_name

String○

電池残量センサーを表す“Battery remaining

deviceamount “の文字列 （固定文字列）
rssi

number○

ルーターが受信しているBLEデバイスの電波強度(0～-120)

data

Object○デバイスのセンサーデータのオブジェクト

Number○

電池残量(0-100 の整数)

uplink_id

String○センサーデータのアップリンク処理の一意のID

date

String○

ルーターがセンサーデータを受信した日付(ISObattery8601) 25桁

Braveridge Co., Ltd.

18

例）電池残量センサーの JSON データ{"group": {"group_id": "GRXJpWIo4BWbD1AurWJMKo6Fx2qr7njBmz","name": ""},"application": {"application_id": "APjmDyv2Y7ZomGPEXs5rccqtiVsaIAqOoT","name": "DemoApp"},"router": {"router_id": "000001be","imsi": "440030011066385","rssi": -51,
"battery": 61,"fw_version": "136.2.8"},"device": {"device_id": "2468800108000001","sensor_id": "0033","sensor_name": "Battery remaining amount","rssi": -34,
"data": {"battery": 100}},"uplink_id": "c442c240-5152-4351-a3c8-c26ad81110f8","date": "2020-06-12T17:56:30+09:00"}

Braveridge Co., Ltd.

19

3. 商標について
・Bluetooth🄬 とワードマークおよびロゴは、Bluetooth SIG INC が所有する登録商標です。
株式会社 Braveridge はこれら商標を使用する許可を受けています。その他のロゴマーク及び商号は各所有者に帰属します。

Braveridge とその製品に関する詳しい情報は、弊社 Web サイトで御確認ください。
https://www.braveridge.com●株式会社ブレイブリッジ (本社)〒819-0373 福岡県福岡市西区周船寺 3-27-2(Tel): 092-834-5789 / (Fax): 092-807-7718●ブレイブリッジグループカンパニー○ブレイブリッジ糸島工場〒819-1122 福岡県糸島市東 1999-19- Apple MFi Manufacture ライセンス認定工場(ライトニングコネクタ製品工場）- Starter Plan 工場○剛橋模具 有限公司（Braveridge Moulding Company）○Braveridge (HK) Co.
○Braveridge China Office○Braveridge Singapore Office
Document code: 1001001-1

Braveridge Co., Ltd.

20