Appearance
因子控制
远程控制开关类因子的状态,如继电器、电机等。
接口概览
| 方法 | 端点 | 描述 |
|---|---|---|
POST | .../factors/{id}/on/ | 开启 |
POST | .../factors/{id}/off/ | 关闭 |
POST | .../factors/{id}/forward/ | 正转(电机) |
POST | .../factors/{id}/antiport/ | 反转(电机) |
POST | .../factors/{id}/stop/ | 停止(电机) |
开启
POST /api/v2/projects/{project_id}/devices/{device_id}/factors/{id}/on/响应示例
json
{
"message": "操作成功",
"token": "cmd_abc123"
}| 字段 | 类型 | 描述 |
|---|---|---|
message | string | 操作结果 |
token | string | 命令令牌,用于追踪执行状态 |
bash
curl -X POST "https://dl.yengear.com/api/v2/projects/proj_abc/devices/123/factors/456/on/" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "X-Organization-Slug: your-org-slug"python
response = requests.post(
f"{API_BASE}/projects/{project_id}/devices/{device_id}/factors/{factor_id}/on/",
headers=headers
)关闭
POST /api/v2/projects/{project_id}/devices/{device_id}/factors/{id}/off/响应格式同上。
电机控制
电机类因子支持正转、反转、停止操作。
正转
POST .../factors/{id}/forward/反转
POST .../factors/{id}/antiport/停止
POST .../factors/{id}/stop/说明
- 只有开关类因子支持控制操作,详见因子类型
- 控制命令异步发送,返回成功仅表示命令已下发
- 可通过
token追踪命令执行状态
相关文档
- 因子类型 - 查看支持控制的因子类型
- 因子管理 - 创建和配置因子
- Access Token - 如何创建和管理访问令牌
