Skip to main content

设备与系统

接口概览​

MethodPathPurpose
GET/system/device-info获取设备序列号、固件版本、传感器和底板型号
GET/system/resource-info获取 CPU、NPU、内存和存储使用情况
GET/system/time获取系统时间、时区和 NTP 配置
PUT/system/time设置系统时间
GET/system/battery获取电池状态
GET/system/check检查是否为首次登录
GET/system/ssh查询 SSH 运行状态
POST/system/ssh启动或停止 SSH
GET/system/secure查询 HTTPS 状态
POST/system/secure启用或禁用 HTTPS
GET/config/export导出设备配置
POST/config/upload导入设备配置
POST/system/reboot重启设备
POST/system/factory-reset恢复出厂设置

获取设备信息​

GET /system/device-info

Response:

{
  "sSerialNumber": "RC1126B-20240101-001",
  "sFirmwareVersion": "V1.0.10",
  "sSensorModel": "SC850SL",
  "sBasePlateModel": "Base Board-V1.0,Expand Board-V1.0"
}
FieldDescription
sSerialNumber设备序列号
sFirmwareVersion固件版本
sSensorModel传感器板型号
sBasePlateModel底板型号

获取系统资源状态​

GET /system/resource-info

Response:

{
  "iCpuUsage": 12,
  "iNpuUsage": 69,
  "sMem": {
    "iMemTotal": 1.94,
    "iMemUsage": 33,
    "iMemUsed": 0.65
  },
  "sStorage": {
    "iStorageTotal": 11.29,
    "iStorageUsage": 37,
    "iStorageUsed": 4.22
  }
}
FieldDescription
iCpuUsageCPU 使用百分比
iNpuUsageNPU 使用百分比
sMem.iMemTotal内存总量
sMem.iMemUsed已用内存
sMem.iMemUsage内存使用百分比
sStorage.iStorageTotal存储总量
sStorage.iStorageUsed已用存储
sStorage.iStorageUsage存储使用百分比

系统时间​

获取系统时间​

GET /system/time

Response:

{
  "sMethod": "ntp",
  "dNtpConfig": {
    "sAddress": "pool.ntp.org",
    "sPort": "123",
    "status": 0
  },
  "iTimestamp": 1784083074,
  "sTimezone": "Asia/Shanghai",
  "sTz": "UTC+8"
}
FieldDescription
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"
}

Response:

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

电池状态​

GET /system/battery

Response:

{
  "isAttached": true,
  "displaySteps": 0,
  "totalSteps": 5,
  "isCharging": false
}
FieldDescription
isAttached是否连接电池
displaySteps当前电量阶梯
totalSteps电量总阶梯数
isCharging电池是否在充电

检查是否首次登录​

GET /system/check

Response:

{
  "bFirst": false
}

bFirst=true 表示设备处于首次登录流程中，需要修改默认密码。

SSH​

查询 SSH 状态​

GET /system/ssh

Response:

{
  "bRunning": true
}

启动或停止 SSH​

POST /system/ssh

Request body:

{
  "bRunning": true
}
FieldDescription
bRunningtrue 启动 SSH，false 停止

HTTPS​

查询 HTTPS 状态​

GET /system/secure

Response:

{
  "sEnable": true
}

启用或禁用 HTTPS​

POST /system/secure

Request body:

{
  "sEnable": true
}

Response:

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

启用 HTTPS 后，后续访问请使用 https://<DEVICE_IP>。

配置管理​

导出配置​

GET /config/export

Response:

{
  "size": 35116544,
  "url": "/download/config.tar"
}
FieldDescription
size配置文件大小
url下载路径；在前面加上设备 IP 组成完整 URL

下载 URL：

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

导入配置​

POST /config/upload

导入配置会覆盖当前设备设置。请先导出当前配置作为备份。

重启​

POST /system/reboot

Response:

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

设备将重启，当前连接会中断。请等待设备重新上线后再继续操作。

恢复出厂设置​

恢复出厂设置需要两阶段确认。

阶段 1：

POST /system/factory-reset

Response:

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

阶段 2，在确认令牌有效期内提交该令牌：

POST /system/factory-reset

Request body:

{
  "sConfirmToken": "adfagghvshf"
}

Response:

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

恢复出厂设置会清除设备的所有配置。请确保在操作前已做好备份。

技术支持与产品讨论​

感谢您选择我们的产品！我们将为您提供多种支持，确保您在使用产品的过程中体验顺畅。我们提供多种沟通渠道，以满足不同的偏好和需求。

Loading Comments...