IoT シミュレータ API ドキュメント

導入事例

IoT シミュレータ API は、お客様とやりとりするお手伝いをします。Bevywise IoTシミュレータネットワークとクライアントの作成と削除、イベントの作成 追加クライアントの公開、サブスクリプションの作成と削除 追加したクライアントに、追加したクライアントのレスポンスの作成と削除 クライアント

この API は、RESTフレームワークHTTP上で動作する。 IoT を統合できる これらのAPIを使用してテスト自動化フレームワークでシミュレータ 完全な回帰テスト。

新しいデバイスを追加

この方法は、既に実行中の新しいMQTTデバイスを追加します。 シミュレータ。 クリーン セッション、メッセージ、QoS は、 等は、この方法の一部として指定することができます。

この API は REST Framework を使って運用しています。 HTTP 経由で IoT シミュレータと統合することができます。 これらの API を使用してテスト自動化フレームワークを完成させる 回帰テスト。

方法:

ニュース

http://localhost:9000/api/addclient

パラメーター:

パラメータ バリューディテール
ネットワーク・コトセン デバイスを作成したいネットワークを選択する
デバイスID デバイスを識別するために使用される
コンテンツ デバイスの詳細
クリーンセッション クリーンセッションの設定
will_flag は、 ウィールフラグを有効にするには
トピックス メッセージのトピック
メッセージ 出版メッセージ
ログイン Will MessaageのQoSレベル
メニュー 保持フラグを有効にする
パスワード 認証資格
パスワード 認証資格

応答:

お問い合わせ
「デバイス」:device_id',
'Status":Device はデータベースに追加され、 ブローカーに接続 お問い合わせ
お問い合わせ

接続されたデバイスを削除します。

このIoTシミュレータAPIは、MQTTを削除するのに役立ちます シミュレータに接続されたデバイス

メソッド

お問い合わせ

http://localhost:9000/api/get/removeclient

パラメーター:

パラメータ バリューディテール
ネットワーク・コトセン デバイスを削除したいネットワークを選択します
デバイスID 接続されたデバイスのID

応答:

お問い合わせ
'Status":Client は削除されます お問い合わせ
お問い合わせ

IoT Simuator API - デバイスを始動

このメソッドは、ブローカーに接続することで、deivceを開始します。

メソッド

お問い合わせ

http://localhost:9000/api/get/startdevice

パラメーター:

パラメータ バリューディテール
ネットワーク・コトセン デバイスを開始するネットワークを選択します。
デバイスID 開始したいデバイスのID

応答:

お問い合わせ
「network」:「network_chosen」, 'Device":'device_id', '"status":'Device is お問い合わせ

デバイスの停止

このIoT シミュレータ API は、デバイスを停止します。 ブローカーから切断します。

メソッド

お問い合わせ

http://localhost:9000/api/get/stopdevice

パラメーター:

パラメータ バリューディテール
ネットワーク・コトセン デバイスを削除したいネットワークを選択します
デバイスID 接続されたデバイスのID

応答:

お問い合わせ
「network」:「network_chosen」,
「デバイス」:device_id',
'"status":'デバイスは停止します お問い合わせ
お問い合わせ

デバイスリストの取得

この方法は、ネットワーク内のデバイスのリストを表示します。

メソッド

お問い合わせ

http://localhost:9000/api/get/deviceslist

パラメーター:

パラメータ バリューディテール
ネットワーク・コトセン デバイスを表示したいネットワークを選択する リスト

応答:

お問い合わせ
'network_name":network_chosen',
「デバイスリスト」: [{"ID":device_id',"Name":device_name',"Description":Description}',
'{"ID":device_id,"Name":device_name',"Description":Description},.] お問い合わせ
お問い合わせ

デバイスの詳細を取得する

この方法は、特定のデバイスの詳細を特定のデバイスに表示します ネットワーク

メソッド

お問い合わせ

http://localhost:9000/api/get/devicedetails

パラメーター:

パラメータ バリューディテール
ネットワーク・コトセン ネットワークを選択すると、詳細を表示したい 特定の装置
デバイスID 詳細を表示したいデバイスのID

応答:

お問い合わせ
'network_name":network_chosen',
'"device":'device_id',
'Will_Details":{}',
'Auth_details":[{ 'auth key':username, 'auth_token': パスワード}',
' ' ' ' ' ' ' ' ' ' ' 「イベント」 お問い合わせ
お問い合わせ

スタートネットワーク

この方法は、それを接続することによって、すべてのデバイスを起動します ブローカー

メソッド

お問い合わせ

http://localhost:9000/api/get/startalldevices

パラメーター:

パラメータ バリューディテール
ネットワーク・コトセン 開始するネットワークを選択

応答:

お問い合わせ
'network_name":network_chosen',
'"Started":デバイスの数が始まりました。
'"失敗":デバイスが起動しない数 お問い合わせ
お問い合わせ

IoT シミュレータ API – ネットワークを停止

この方法は、デバイスを切断することにより、すべてのデバイスを停止します。 ブローカー。

メソッド

お問い合わせ

http://localhost:9000/api/get/stopalldevices

パラメーター:

パラメータ バリューディテール
ネットワーク・コトセン 停止するネットワークを選択

応答:

お問い合わせ
'network_name":network_chosen',
'"Stopped_count":デバイスの接続が切断された数 お問い合わせ
お問い合わせ

ネットワークリストの取得

この方法は、シミュレータで作成されたすべてのネットワークをリストします

メソッド

お問い合わせ

http://localhost:9000/api/get/networklist

応答:

お問い合わせ
'network_list" は、 お問い合わせ
お問い合わせ

ネットワークステータスの取得

この方法は、指定したネットワークのステータスを表示します。

メソッド

お問い合わせ

http://localhost:9000/api/get/networkstatus

パラメーター:

パラメータ バリューディテール
ネットワーク・コトセン ステータスを知るためにネットワークを選択

応答:

"network_name":network_chosen" は、
'「実行」:接続するデバイスの数'、
'Not_Running":接続されていないデバイスの数 お問い合わせ
お問い合わせ

ネットワークを選択

このIoT シミュレータ API は、API のネットワークを選択するために使用されます。 統合。

メソッド

お問い合わせ

http://localhost:9000/api/get/setnetwork

パラメーター:

パラメータ バリューディテール
ネットワーク・コトセン ネットワーク名を選択してください

応答:

お問い合わせ
'network_name":network_chosen',
「Status」:ネットワークが選択されました お問い合わせ
お問い合わせ

イベント停止

すべての公開イベントを中止するために使用します。

メソッド

お問い合わせ

http://localhost:9000/api/get/stopevent

パラメーター:

パラメータ バリューディテール
ネットワーク・コトセン イベントを停止するネットワークを選択
イベント_id 構成されたEvnetsのID

応答:

お問い合わせ
'network_name":network_chosen',
「Event_ID」:event_id',
「ステータス」: イベント中止 お問い合わせ
お問い合わせ

再開イベント

停止イベントを再開するために使用します。

メソッド

お問い合わせ

http://localhost:9000/api/get/resumeevent

パラメーター:

パラメータ バリューディテール
ネットワーク・コトセン イベントを再開するためのネットワークを選択
イベント_id 構成イベントのID

応答:

お問い合わせ
'network_name":network_chosen',
「Event_ID」:event_id',
「ステータス」: イベント再開 お問い合わせ
お問い合わせ

IoT シミュレータ API – 公開

この方法は、特定のデバイスのイベントを特定のデバイスで公開するために使用されます ネットワーク

メソッド

ニュース

http://localhost:9000/api/publishclient

パラメーター:

パラメータ バリューディテール
ネットワーク・コトセン 公開イベントを表示するネットワークを選択 特定の装置
デバイスID 出版デバイスのID
トピック 出版イベントのトピック
メッセージ 新着情報
ログイン QoSレベル
メンテナンス 公開デバイス用のフラグを保持する

応答:

お問い合わせ
'network_name":network_chosen',
「トピック」:トピック、
'"Status":Published',
「メッセージ」:メッセージ」、
'"公開":time_of_publish',
お問い合わせ

公開_with_Error

この方法は、特定のイベントを破損したイベントを公開するために使用されます ネットワーク内のデバイス。

メソッド

ニュース

http://localhost:9000/api/publishclient_with_corruption

パラメーター:

パラメータ バリューディテール
ネットワーク・コトセン 破損した公開イベントを表示するネットワークを選択
デバイスID 出版デバイスのID
トピック 出版イベントのトピック
メッセージ 新着情報
ログイン QoSレベル
メンテナンス 公開デバイス用のフラグを保持する

応答:

お問い合わせ
'network_name":network_chosen',
「トピック」:トピック、
'"Status":Published',
「メッセージ」:メッセージ」、
'"公開":time_of_publish',
お問い合わせ

公開を削除 メッセージ

この方法は、特定のイベントトピックからイベントのトピックを削除するために使用されます ネットワーク内のデバイス

メソッド

ニュース

http://localhost:9000/api/removepublish

パラメーター:

パラメータ バリューディテール
ネットワーク・コトセン ネットワークを選択してイベントトピックを削除 特定の装置
デバイスID イベントトピックが削除したいデバイスのID
トピック 削除されるイベントのトピック

応答:

お問い合わせ
「デバイス」:'device_id',
「Status」:イベントトピックはデータベースから削除されます お問い合わせ
お問い合わせ

リクエストに対する応答の追加

この方法は、特定の新しい行動パターンを追加するために使用されます ネットワーク内のデバイス

メソッド

ニュース

http://localhost:9000/api/addresponse ディレクティブ

パラメーター:

パラメータ バリューディテール
ネットワーク・コトセン ネットワークを選択して、新しい行動パターンを追加します。 特定の装置
デバイスID 応答が作成されるデバイスの ID
イベント_トピック イベントトピックを作成
イベントデータ イベントデータの公開
コマンド_data 応答データ
ログイン RQoSレベル
メンテナンス フラグを保持する

応答:

お問い合わせ
「デバイス」:'device_id',
'Status":リクエストレスポンスメッセージを追加しました ログイン お問い合わせ
お問い合わせ

リクエストの応答を削除します

このメソッドは、特定の挙動パターンから挙動パターンを削除するために使用されます。 ネットワーク内のデバイス

メソッド

ニュース

http://localhost:9000/api/removeresponse ディレクティブ

パラメーター:

パラメータ バリューディテール
ネットワーク・コトセン ネットワークを選択して、行動パターンをから削除します 特定の装置
デバイスID 応答トピックが望むデバイスのID 削除
トピック 応答を削除したいイベントトピック

応答:

お問い合わせ
'device":'device_id', 'Status":Behavior Pattern はデータベースから削除されます お問い合わせ お問い合わせ

行動シミュレーションの停止

このメソッドは、挙動パターン/レスポンスをストップするために使われます。 インフォメーション ネットワーク内のデバイス

メソッド

ニュース

http://localhost:9000/api/stopres

パラメーター:

パラメータ バリューディテール
ネットワーク・コトセン アクションパターンの動作を停止するネットワークを選択する 特定の装置
デバイスID 応答が停止したいデバイスのID
トピック 応答を停止したいイベントトピック

応答:

お問い合わせ
「デバイス」:'device_id',
「Status」:行動シミュレーションが停止 お問い合わせ
お問い合わせ

会員登録

このメソッドは、特定のデバイス用のコマンドを購読するために使用されます ネットワーク

メソッド

ニュース

http://localhost:9000/api/subscribeclient

パラメーター:

パラメータ バリューディテール
ネットワーク・コトセン 特定のコマンドを購読するネットワークを選択 デバイス
デバイスID 購読されたトピックが追加されたデバイスの ID
トピック 購読されるトピック
ログイン QoSレベル
アドオン データベースに追加されたトピック

応答:

お問い合わせ
"device":'device_id', 'Status":トピック お問い合わせ

サブスクリプションの詳細を取得する

このメソッドは、サブスクリプションの詳細を取得するために使用されます ネットワーク内の特定のデバイス

メソッド

お問い合わせ

http://localhost:9000/api/get/subscribedetails

パラメーター:

パラメータ バリューディテール
ネットワーク・コトセン ネットワークを選択してサブスクリプションの詳細を取得する 特定の装置
デバイスID サブスクリプションの詳細が表示されるデバイス ID 取得済み

応答:

お問い合わせ
'network_name":network_chosen',
「デバイス」:'device_id',
'topics': ['topic1','topic2'] は、

新規登録

このメソッドは、新しいサブスクリプショントピックを追加するために使用されます。 ネットワーク内の特定のデバイス

メソッド

ニュース

http://localhost:9000/api/addsubscribe

応答:

お問い合わせ
'network_name":network_chosen',
「デバイス」:'device_id',
'"Subscription_details":[{ "購読": if_to_subscribe, "Command_Topic": トピック, "QoS": QoS、 "Command_ID": トピック_id},{{}",
お問い合わせ

パラメーター:

パラメータ バリューディテール
ネットワーク・コトセン 特定のコマンドを追加するためのネットワークを選択 デバイス
デバイスID 購読されたトピックがなければならないデバイスの ID 追加する
トピック 新規登録したトピック
ログイン QoSレベル

応答:

お問い合わせ
「デバイス」:'device_id',
'Status":Command Topic をデータベースに追加 ログイン お問い合わせ
お問い合わせ

購読する

この方法は、特定のデバイスからコマンドを削除するために使用されます ネットワーク

メソッド

ニュース

http://localhost:9000/api/removesubscribe

パラメーター:

パラメータ バリューディテール
ネットワーク・コトセン 特定のコマンドからコマンドを削除するネットワークを選択 デバイス
デバイスID サブスクリプションが行われるデバイスのID 削除
トピック サブスクリプショントピックを削除

応答:

お問い合わせ
「デバイス」:'device_id',
'Status":Command Topic はデータベースから削除されます お問い合わせ
お問い合わせ

購読解除 すべて

この方法は、ネットワーク内のすべてのコマンドをunsubscribeするために使用されます。

メソッド

ニュース

http://localhost:9000/api/unsubscribeall

パラメーター:

パラメータ バリューディテール
ネットワーク・コトセン ネットワークを選択して、すべてのコマンドを退会
デバイスID サブスクリプションが行われるデバイスのID 削除
トピック サブスクリプショントピックを削除

応答:

お問い合わせ
「ステータス」: 接続デバイスのすべてのトピック 購読解除 お問い合わせ
お問い合わせ

Bevywiseに問い合わせる
IoTシミュレータ?

よくある質問 サイトマップ