错误处理接口

介绍

错误处理接口：提供用户日志记录、向 UI 发送错误/警告信号等功能，用于在任务执行过程中记录状态和反馈异常。

功能	Python
记录日志消息	✔
清理日志文件	✔

日志管理

Python接口

log_message(message, logger='default', include_timestamp=False)

功能说明
将消息写入用户日志文件。日志文件自动以时间戳命名：{logger}_{YYYYMMDD_HHMMSS}.log，保存在 /root/data/daystar_api/user_logs/。

参数说明

参数名	类型	必填/默认值	说明
message	str	必填	要记录的日志消息内容。
logger	str	默认: 'default'	日志器名称，作为日志文件名的前缀。
include_timestamp	bool	默认: False	True 时在日志内容中包含时间戳。

返回值

类型	说明
bool	True 表示记录成功。

调用示例

from daystar_api.lowlevel_skills import log_message

log_message("任务开始")
log_message("处理第 1 项", logger="process_log", include_timestamp=True)

---

clear_log(logger_name='', log_dir='/root/data/daystar_api/user_logs/')

功能说明
清理用户日志文件。可清除所有日志或指定日志器的日志。此函数不需要 API 初始化即可使用。

参数说明

参数名	类型	必填/默认值	说明
logger_name	str	默认: ''	指定日志器名称时只删除该日志器的文件；为空时删除所有日志文件。
log_dir	str	默认: '/root/data/daystar_api/user_logs/'	日志目录路径。

返回值

类型	说明
int	已删除的日志文件数量。

调用示例

from daystar_api.lowlevel_skills import clear_log

# 删除所有日志
deleted = clear_log()
print(f"已删除 {deleted} 个日志文件")

# 只删除指定日志器的日志
deleted = clear_log("my_task")

错误和警告处理（暂不可用）

Python接口

raise_error(message)

功能说明
向 UI 发送错误信号，错误信息将显示在界面上。

参数说明

参数名	类型	必填/默认值	说明
message	str	必填	错误信息内容。

返回值

类型	说明
RaiseErrorResponse	state.code == 0 表示发送成功。

调用示例

from daystar_api.lowlevel_skills import raise_error

response = raise_error("传感器连接失败")
if response.state.code == 0:
    print("错误信号已发送至 UI")

---

raise_warn(message)

功能说明
向 UI 发送警告信号，警告信息将显示在界面上。

参数说明

参数名	类型	必填/默认值	说明
message	str	必填	警告信息内容。

返回值

类型	说明
RaiseWarnResponse	state.code == 0 表示发送成功。

调用示例

from daystar_api.lowlevel_skills import raise_warn

response = raise_warn("电量低于 20%，建议尽快充电")
if response.state.code == 0:
    print("警告信号已发送至 UI")