API コマンド仕様書
BraveGATE 対応

REV 1.２

LTE-BLE Router
BBLTR1-LP
DESIGNED BY Braveridge Co., Ltd.

Braveridge Co., Ltd.

1

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

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

1.2.

各コマンドの実行結果に関して ............................................................................................... 41.3.

電源オペレーション ............................................................................................................ 5

1.3.1.

電源オフ ................................................................................................................. 5

1.3.2.

ルーター再起動.......................................................................................................... 6

1.4.

ファームウェアアップデート ...................................................................................................... 7

1.4.1.
1.5.

デバイス検索 .................................................................................................................. 8

1.5.1.
1.6.

周辺のデバイスの検索 .................................................................................................. 8

死活確認 ...................................................................................................................... 9

1.6.1.
1.7.

ファームウェアアップデート(DFU) ........................................................................................ 7

ルーター死活確認 ....................................................................................................... 9デバイスフィルタ ............................................................................................................... 10

1.7.1.

デバイス検索対象フィルタ上書き設定 ................................................................................ 10

1.7.2.

デバイス検索対象フィルタ設定クリア .................................................................................. 12

Braveridge Co., Ltd.

2

1 コマンド仕様
1.1.

BraveGATE 利用時のコマンド仕様

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

説明

device_id

16桁(HEX表記, case-sensitive)

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

router_id8桁(HEX表記, case-sensitive)

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

sensor_id

4桁(HEX表記, case-sensitive)

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

group id

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

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

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

Braveridge Co., Ltd.

3

1.2.

各コマンドの実行結果に関してBraveGATE での各コマンドに関しては、非同期要求-応答パターンにて実装されているため、各コマンドの結果については、非同期ポーリングにてコマンドの結果を取得する必要あります。
コマンド結果についは、以下の様に、target.routers[].status key の値が、”processed” であれば実行(成功)、”rejected” であれば実行できなかった(失敗) となります。 失敗した場合は、target.routers[].reasen に失敗理由の値が入ります。
例) コマンド結果{…
"targets": {"routers": [{"router_id": "00000123","status": "rejected",← 失敗"reason": "router unreachable.", ←"sent_at": "2021-02-04T19:37:33+09:00"},{"router_id": "00000456","status": "processed","sent_at": "2021-02-04T19:37:33+09:00"}}}
コマンドの実行可非についての問い合せの詳細については、「BraveGATE API ユーザーズガイド」の「コマンド結果の詳細の取得(GET /commands/{command_id})」を参照下さい。

Braveridge Co., Ltd.

4

1.3.

電源オペレーション
電源オフ

1.3.1.

指定したルーターに電源オフを指示します。
NOTE
USB 電源が供給されている状態では、再び電源が ON になります。
電源から外し可搬時に電波 OFF にしたい場合等に使用して下さい。
電源オフリクエストパラメーター
JSON KEY値

必須説明

nameString○

POWER_OFFtarget

Object○Array(String)△(選択)

routers

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

groupsArray(String)△(選択

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

Body の例)
POST /commands{"name": "POWER_OFF","targets": {"routers": ["10000001","10000002","10000003"]}}

Braveridge Co., Ltd.

5

ルーター再起動

1.3.2.

指定したルーターへ再起動を指示します。
電源オフ リクエストパラメータ
JSON KEY値必須説明name

String○RESTARTtargetObject○Array(String)△(選択)

routers

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

groupsArray(String)△(選択)

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

Body の例)
POST /commands{"name": "RESTART","targets": {"routers": ["10000001","10000002","10000003"]}}

Braveridge Co., Ltd.

6

1.4.

ファームウェアアップデート
ファームウェアアップデート(DFU)

1.4.1.

指定したルーターにファームウェアアップデートの実行します。
バージョンを指定したバージョンアップ、バージョンダウンをサポートしています。

DFU リクエストパラメータ
JSON KEY値

必須

説明nameString○UPDATE_ROUTER_FIRMWARE

targetObject○Array(String)△(選択)

routers

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

groupsArray(String)△(選択)

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

paramsObjectversion○String

versionを指定しなければ、省略可能
version を指定してFirmwareのバージョンアップ、バージョンダウンをサポートします。
verisonを指定しなかった場合は、現在のリリース最新バージョンが指定されます。

Body の例)
POST /commands{"name": " UPDATE_ROUTER_FIRMWARE","targets": {"routers": ["10000001","10000002","10000003"]},"params": {"version": "1.2.3"}}

Braveridge Co., Ltd.

7

1.5.

デバイス検索周辺のデバイスの検索

1.5.1.

指定したルーターの周辺にあるデバイスの検索を行います。周辺にルーターと登録情報が一致した
BraveGATE 対応エンドデバイスを検索し再度接続処理を行います。
NOTE
複数のルーター、エンドデバイスが設置された場所にて、ルーターもしくはエンドデバイスを移動した場合に本コマンドを実行すると、デバイスへ対するダウンリンク命令の到達可能性を改善できる場合があります。
なんらかの理由により、再起動、電源オフを行わないままルーター、エンドデバイスを移動して設置した場
合には、本コマンドを実行して下さい。
電源オフ リクエストパラメータ
JSON KEY値

必須

説明

nameString○

SCAN_DEVICE

targetObject○Array(String)△(選択)

routers

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

groupsArray(String)△(選択)

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

Body の例)
POST /commands{"name": "SCAN_DEVICE","targets": {"routers": ["10000001","10000002","10000003"]}}

Braveridge Co., Ltd.

8

1.6.

死活確認
ルーター死活確認1.6.1.

指定したルーターへの死活確認コマンドへの返答を指示します。
電源オフ リクエストパラメータ
JSON KEY値

必須

説明

name

String○CHECK_ALIVE

targetObject○Array(String)△(選択)

routers

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

groupsArray(String)△(選択)

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

Body の例)
POST /commands{"name": "CHECK_ALIVE","targets": {"routers": ["10000001","10000002","10000003"]}}

Braveridge Co., Ltd.

9

1.7.

デバイスフィルタ
デバイス検索対象フィルタ上書き設定

1.7.1.

ルーターに対して、デバイス検索するエンドデバイスを制限するフィルタを指定します。既存の設定については消去され、上書きにて設定されます。設定できるdevice_idは100個までとなります。フィルタ設定後、ルーターは再起動されます。
注) ルーターに設定できる上限についてもID 100個までとなります。なを、100個まで指定できますが、BLEルーターに接続するデバイスの台数については通常8台までとなります。8台以上の接続につきましては別途弊社営業までお問い合わせ下さい。
NOTE
フィルタ設定を行なうと、既存ルーターからの周辺デバイス情報を元にBraveGATE COREにて管理しているデバイスへのダウンリンク経路情報もクリアされます。フィルタ設定を行なった直後などは、デバイスへのダウンリンク経路情報が存在しないため、ダウンリンクコマンドが失敗する場合があります。
Scan対象フィルタ設定追加 リクエストパラメータ
JSON KEY

値

必須

説明

Name

String○

SET_FILTER_DEVICE

TargetObject○Array(String)△(選択)

routers

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

groupsArray(String)△(選択)

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

ParamsObjectdevice_id

Array(String)○

通信許可するdevice_idを配列で指定

Body の例)
POST /commands{"name": "SET_FILTER_DEVICE","params": {"device_id": ["2468800001000001","2468800001000002","2468800001000003","2468800001000004","2468800001000005",〜省略〜"2468800001000100"

Braveridge Co., Ltd.

10

]
},
"targets": {"routers": ["10000001","10000002","10000003"]}}

Braveridge Co., Ltd.

11

デバイス検索対象フィルタ設定クリア

1.7.2.

ルーターに設定されたデバイス検索対象のフィルタをクリアします。フィルタ設定クリア後、ルーターは再起動されます。
NOTE
フィルタ設定を行なうと、既存ルーターからの周辺デバイス情報を元にBraveGATE COREにて管理しているデバイスへのダウンリンク経路情報もクリアされます。フィルタ設定を行なった直後などは、デバイスへのダウンリンク経路情報が存在しないため、ダウンリンクコマンドが失敗する場合があります。
Scan 対象フィルタ設定クリアリクエストパラメーター
JSON KEY値

必須

説明

NameString○

CLEAR_FILTER_DEVICE

TargetObject○Array(String)△(選択)

routers

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

groupsArray(String)△(選択)

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

Body の例)
POST /commands{"name": "CLEAR_FILTER_DEVICE","targets": {"routers": ["10000001","10000002","10000003"]}}

Braveridge Co., Ltd.

12

Braveridge とその製品に関する詳しい情報は、弊社 Web サイトで御確認ください。
https://www.braveridge.com●株式会社ブレイブリッジ (本社)〒819-0373 福岡県福岡市西区周船寺 3-27-2(Tel): 092-834-5789 / (Fax): 092-807-7718●ブレイブリッジ糸島工場〒819-1122 福岡県糸島市東 1999-19

Braveridge Co., Ltd.

13