メインコンテンツまでスキップ

デバイス & システム

エンドポイント概要​

MethodPath目的
GET/system/device-infoデバイスのシリアル番号、ファームウェアバージョン、センサーボードおよびベースボードのモデルを取得
GET/system/resource-infoCPU、NPU、メモリ、ストレージの使用状況を取得
GET/system/timeシステム時刻、タイムゾーン、NTP 設定を取得
PUT/system/timeシステム時刻を設定
GET/system/batteryバッテリー状態を取得
GET/system/check初回ログインかどうかを確認
GET/system/sshSSH の動作状態を照会
POST/system/sshSSH を開始または停止
GET/system/secureHTTPS 状態を照会
POST/system/secureHTTPS を有効化または無効化
GET/config/exportデバイス設定をエクスポート
POST/config/uploadデバイス設定をインポート
POST/system/rebootデバイスを再起動
POST/system/factory-reset工場出荷時設定に復元

デバイス情報の取得​

GET /system/device-info

レスポンス:

{
  "sSerialNumber": "RC1126B-20240101-001",
  "sFirmwareVersion": "V1.0.10",
  "sSensorModel": "SC850SL",
  "sBasePlateModel": "Base Board-V1.0,Expand Board-V1.0"
}
Field説明
sSerialNumberデバイスのシリアル番号
sFirmwareVersionファームウェアバージョン
sSensorModelセンサーボードのモデル
sBasePlateModelベースボードのモデル

システムリソース状態の取得​

GET /system/resource-info

レスポンス:

{
  "iCpuUsage": 12,
  "iNpuUsage": 69,
  "sMem": {
    "iMemTotal": 1.94,
    "iMemUsage": 33,
    "iMemUsed": 0.65
  },
  "sStorage": {
    "iStorageTotal": 11.29,
    "iStorageUsage": 37,
    "iStorageUsed": 4.22
  }
}
Field説明
iCpuUsageCPU 使用率（パーセンテージ）
iNpuUsageNPU 使用率（パーセンテージ）
sMem.iMemTotalメモリ総量
sMem.iMemUsed使用中メモリ量
sMem.iMemUsageメモリ使用率（パーセンテージ）
sStorage.iStorageTotalストレージ総容量
sStorage.iStorageUsed使用中ストレージ容量
sStorage.iStorageUsageストレージ使用率（パーセンテージ）

システム時刻​

システム時刻の取得​

GET /system/time

レスポンス:

{
  "sMethod": "ntp",
  "dNtpConfig": {
    "sAddress": "pool.ntp.org",
    "sPort": "123",
    "status": 0
  },
  "iTimestamp": 1784083074,
  "sTimezone": "Asia/Shanghai",
  "sTz": "UTC+8"
}
Field説明
sMethod時刻ソース。ntp または manual
dNtpConfig.sAddressNTP サーバーアドレス
dNtpConfig.sPortNTP ポート
dNtpConfig.statusNTP ステータス。0 は成功を意味します
iTimestamp秒単位の Unix タイムスタンプ
sTimezoneタイムゾーンの都市名
sTzタイムゾーン（例：UTC+8）

システム時刻の設定​

PUT /system/time

NTP モードのリクエストボディ:

{
  "sMethod": "ntp",
  "dNtpConfig": {
    "sAddress": "pool.ntp.org",
    "sPort": "123"
  },
  "sTimezone": "Asia/Shanghai",
  "sTz": "UTC+8"
}

手動モードのリクエストボディ:

{
  "sMethod": "manual",
  "iTimestamp": 1784083074,
  "sTimezone": "Asia/Shanghai",
  "sTz": "UTC+8"
}

レスポンス:

{
  "iTimestamp": 1784083074,
  "sTimezone": "Asia/Shanghai",
  "sTz": "UTC+8"
}

バッテリー状態​

GET /system/battery

レスポンス:

{
  "isAttached": true,
  "displaySteps": 0,
  "totalSteps": 5,
  "isCharging": false
}
Field説明
isAttachedバッテリーが接続されているかどうか
displaySteps現在のバッテリーレベルのステップ数
totalStepsバッテリーレベルの総ステップ数
isChargingバッテリーが充電中かどうか

初回ログインの確認​

GET /system/check

レスポンス:

{
  "bFirst": false
}

bFirst=true は、デバイスが初回ログインフロー中であり、デフォルトパスワードを変更する必要があることを示します。

SSH​

SSH 状態の照会​

GET /system/ssh

レスポンス:

{
  "bRunning": true
}

SSH の開始または停止​

POST /system/ssh

リクエストボディ:

{
  "bRunning": true
}
Field説明
bRunningSSH を開始する場合は true、停止する場合は false

HTTPS​

HTTPS 状態の照会​

GET /system/secure

レスポンス:

{
  "sEnable": true
}

HTTPS の有効化または無効化​

POST /system/secure

リクエストボディ:

{
  "sEnable": true
}

レスポンス:

{
  "code": 0,
  "message": "Settings applied successfully"
}

HTTPS を有効化した後は、以降のアクセスに https://<DEVICE_IP> を使用してください。

設定管理​

設定のエクスポート​

GET /config/export

レスポンス:

{
  "size": 35116544,
  "url": "/download/config.tar"
}
Field説明
size設定ファイルサイズ
urlダウンロードパス。完全な URL にするにはデバイス IP を前に付加します

ダウンロード URL:

http://<DEVICE_IP>/download/config.tar

設定のインポート​

POST /config/upload

設定をインポートすると、現在のデバイス設定は上書きされます。事前に現在の設定をエクスポートしてバックアップを作成してください。

再起動​

POST /system/reboot

レスポンス:

{
  "code": 0,
  "message": "success"
}

デバイスは再起動し、現在の接続は切断されます。続行する前に、デバイスがオンラインに戻るまでお待ちください。

工場出荷時設定へのリセット​

工場出荷時設定へのリセットには 2 段階の確認が必要です。

ステージ 1:

POST /system/factory-reset

レスポンス:

{
  "code": 0,
  "sConfirmToken": "adfagghvshf"
}

ステージ 2: 有効期限内に確認トークンを送信します:

POST /system/factory-reset

リクエストボディ:

{
  "sConfirmToken": "adfagghvshf"
}

レスポンス:

{
  "code": 0,
  "message": "success"
}

工場出荷時設定へのリセットを行うと、デバイスのすべての設定が消去されます。実行する前に必ずバックアップを取得してください。

テクニカルサポートと製品ディスカッション​

当社製品をお選びいただきありがとうございます。お客様が当社製品をスムーズにご利用いただけるよう、さまざまなサポートをご用意しています。お好みやニーズに応じて選べる複数のコミュニケーションチャネルを提供しています。

Loading Comments...