研几科技·文档中心

Appearance

更多接口 ​

重启设备 ​

向设备发送重启命令。只有设备在线时才能执行此操作。

重要提示

并不是所有设备支持重启操作。

请求 ​

http
POST /api/v2/devices/{device_id}/reboot/

响应 ​

json
{
    "message": "重启命令已发送",
    "token": "命令令牌"
}

错误响应 ​

状态码说明
401未认证
404设备不存在
503设备离线或无法重启

示例 ​

Python ​

python
def reboot_device(device_id):
    """重启设备
    
    Args:
        device_id: 设备ID
    """
    headers = {
        "Authorization": f"Bearer {ACCESS_TOKEN}",
        "Content-Type": "application/json"
    }
    
    url = f"{API_BASE}/devices/{device_id}/reboot/"
    response = requests.post(url, headers=headers)
    return response.json()

# 使用示例
device_id = "device_1"
result = reboot_device(device_id)
print(f"重启结果: {result}")

cURL ​

bash
curl -X POST "https://ums.holdingbyte.com/api/v2/devices/device_1/reboot/" \
     -H "Authorization: Bearer your_access_token"

设置串口参数 ​

设置设备的串口通信参数，包括波特率、数据位、停止位、校验位和流控制。只有设备在线时才能执行此操作。

重要提示

并不是所有设备支持设置串口参数。

请求 ​

http
POST /api/v2/devices/{device_id}/set-serial/

请求参数 ​

字段类型必填默认值说明
baud_rateinteger否9600波特率，支持：1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200
data_bitsinteger否8数据位，支持：7, 8
stop_bitsinteger否1停止位，支持：1(1位), 15(1.5位), 2(2位)
parityinteger否0校验位，0:无校验, 1:奇校验, 2:偶校验, 3:标记, 4:空格

请求示例 ​

json
{
    "baud_rate": 115200,
    "data_bits": 8,
    "stop_bits": 1,
    "parity": 0
}

响应 ​

json
{
    "message": "串口参数设置命令已发送",
    "token": "命令令牌"
}

错误响应 ​

状态码说明
400参数错误
401未认证
404设备不存在
503设备离线或无法设置

示例 ​

Python ​

python
def set_serial_params(device_id, baud_rate=9600, data_bits=8, stop_bits=1, parity=0):
    """设置设备串口参数
    
    Args:
        device_id: 设备ID
        baud_rate: 波特率
        data_bits: 数据位
        stop_bits: 停止位
        parity: 校验位
    """
    headers = {
        "Authorization": f"Bearer {ACCESS_TOKEN}",
        "Content-Type": "application/json"
    }
    
    data = {
        "baud_rate": baud_rate,
        "data_bits": data_bits,
        "stop_bits": stop_bits,
        "parity": parity
    }
    
    url = f"{API_BASE}/devices/{device_id}/set-serial/"
    response = requests.post(url, headers=headers, json=data)
    return response.json()

# 使用示例
device_id = "device_1"
# 设置串口参数为：115200, 8N1, 无流控
result = set_serial_params(
    device_id,
    baud_rate=115200,
    data_bits=8,
    stop_bits=1,
    parity=0
)
print(f"设置结果: {result}")

cURL ​

bash
curl -X POST "https://ums.holdingbyte.com/api/v2/devices/device_1/set-serial/" \
     -H "Authorization: Bearer your_access_token" \
     -H "Content-Type: application/json" \
     -d '{
         "baud_rate": 115200,
         "data_bits": 8,
         "stop_bits": 1,
         "parity": 0
     }'