概要
このページでは、UbiBot デバイス（WS1 および WS1 Pro モデルなど）を管理する低レベルのシリアル API について説明します。現在、API にアクセスする方法は次の2つがあります。
1.USB シリアルポート
デバイス接続時の注意点：
・付属の Micro-USB ケーブル、または内部に4本の線（プラス、マイナス、送信、受信）がある互換ケーブルを使用してください。一部の安価なケーブルは充電のみ対応です。
・PC に接続する前にデバイスの電源をオフにしてください。
・正しい USB シリアルポートが選択され、有効になっていることを確認してください。
シリアルポート設定：
・ボーレート（Baudrate）：115200
・データビット（Data bits）：8
・パリティ（Parity）：なし
・ストップビット（Stop Bits）：1
・送受信形式（Receive & Send）：テキスト形式
シリアル API：デバイス情報の読み取り
シリアル API：デバイス情報の読み取り
以下のAPIは、接続されたデバイスから情報を取得します。
デバイスファームウェア情報の取得
デバイスのファームウェアバージョン、チャンネル ID、ユーザー ID、シリアル番号などを返します。
リクエスト：
{"command":"ReadProduct"}
レスポンス：
{"ProductID":"ubibot-ws1-cn","SeriesNumber":"XXXXXX","Host":"webapi.ubibot.com","CHANNEL_ID":"XX","USER_ID":"XXX-XXXX","USAGE":"0%","firmware":"ws1_v1.6_17_10_18","backup_ip":"xxx.xxx.xxx.xxx"}
デバイス Wi-Fi 設定の取得
デバイスが接続している Wi-Fi の SSID とパスワードを返します。
リクエスト：
{"command":"ReadWifi"}
レスポンス：
{"SSID":"XXXXXX","password":"XXXXXX","type":"WPA"}
デバイスセンサー設定（メタデータ）の取得
デバイスのセンサーのメタデータ（サンプリング間隔など）を返します。
リクエスト：
{"command":"ReadMetaData"}
レスポンス：
{"fn_th":120,"fn_light":60,"fn_mag":86400,"fn_mag_int":2,"fn_acc_tap1":0,"fn_acc_tap2":0,"fn_acc_act":0,"fn_acc_min":90,"fn_bt":300,"fn_ext":600,"fn_battery":36
00,"fn_dp":600,"cg_data_led":1}
保存されているセンサーデータの取得
デバイス内に保存されているセンサーデータを返します。WS1 は 300,000 件以上のデータを保持できます。
リクエスト：
{"command":"ReadData"}
レスポンス：
{"created_at":"2015-12-17T18:16:22Z","field1":0}……
エラーログの取得
リクエスト：
{"command":"GetLastError"}
近隣 Wi-Fi のスキャン
デバイスの周囲にある Wi-Fi を返します。
リクエスト：
{"command":"ScanWifiList"}
レスポンス：
{"WiFi_List_Sum":%d }\n\r
{"SSID":"%s","rssi":%d,"type":%d}\n\r
デバイス診断テストの実行
デバイスが全てのセンサーを読み取り、結果を返します。
リクエスト：
{"command":"CheckSensors"}
レスポンス：
{"created_at":"2017-05-12T04:41:10Z","temp_val":32.132446,"humi_val":17,"light_val":767.359985,"power_vol_val":4.524133,"ssid":"m_work-GN","rssi":-37,"acce_xval":0,"acce_yval":0,"acce_zval":0,"mag_val":1,"ext_temp_val":65535}
シリアル API：デバイス設定の変更（データのバックアップ必須）
以下のコマンドは、デバイスの設定を変更するために使用されます。これらのコマンドを実行する前に、必ずすべてのデータをバックアップするか、同期してください。
デバイス内全データの削除
デバイスに保存されている全データを削除します（30 秒程度かかる場合があります）。
注意：データは完全に削除されます。
リクエスト：
{"command":"ClearData"}
デバイスセンサー設定の変更
このコマンドは、センサーのメタデータを変更するために使用されます。
※リクエストで送信する新しいメタデータは、例に示す通りJSON形式で指定する必要があります。
リクエスト：
{"command":"SetMetaData","metadata":"{\"fn_th\":60,\"fn_light\":60,\"fn_mag\":120,\"fn_mag_int\":2,\"fn_acc_tap1\":0,\"fn_acc_tap2\":0,\"fn_acc_act\":0,\"fn_acc_min\":5,\"fn_bt\":120,\"fn_ext_t\":1480041854,\"fn_battery\":120,\"fn_dp\":120,\"cg_data_led\":\"on\"}"}
成功レスポンス：
{\"status\":0,\"code\": 0x00}
Wi-Fi 設定の変更
デバイスが接続する Wi-Fi 情報を更新します。
・パラメータ：
・SSID：Wi-Fi 名称
・Password：Wi-Fi パスワード（プレーンテキスト）
・Type：WPA / WEP / OPEN
・Backup IP：DNS が使えない場合の予備 IP
リクエスト：
{"command":"SetupWifi","SSID":"XXXXX","password": "XXXXX","backup_ip":"101.201.30.5","type":"wpa"}
成功レスポンス：
{\"status\":0,\"code\": 0x00}
デバイス Host アドレスの変更
自社サーバーやプライベートプラットフォームに接続させたい場合は UbiBot Developer Program への参加が必要です。
参加特典：
・デバイスとサーバー通信の API ドキュメント
・サーバー側クイックスタート SDK（PHP デモコード）
・プライベート IoT プラットフォーム構築ガイド
・ベータデバイス、ベータ版リリースへのアクセス
・高度な API 機能
・開発サポートおよびパートナーシップ機会
