TG-PlatformPlus/help.md

1. 预置全局变量

_G

• 类型：class实例
• 描述：程序启动时为空，生命周期为软件运行时间，可在不同指令中访问
• 包含方法：
  • get(name: str) -> any
  • set(name: str, value: any) -> None
  • getall() -> dict
  • getsize() -> double 单位：kb
  • clear(name: str) -> None 传空值表示清空所有

cmdInfo

• 类型：dict
• 描述：包含当前指令的信息

projectInfo

• 类型：dict
• 描述：包含当前活动工程的信息

interfaceInfo

• 类型：dict
• 描述：包含指令执行所对应的接口的信息

userInfo

• 类型：dict
• 描述：包含当前登录用户的信息

deviceInfo

• 类型：dict
• 描述：包含当前设备的信息

2. 接口函数

finish()

• 参数：无
• 返回值：无
• 描述：调用此接口，指令运行结束。脚本中必须显式地调用此函数，否则指令将不会停止。

stopAll()

• 参数：无
• 返回值：int - 已停止的任务数量
• 描述：立即停止所有运行中的任务（包括当前任务和其他并行任务）。返回实际停止的任务数量。

log_d(msg: str, color: str = 'blue')

• 参数：
  • msg: 日志内容
  • color: 日志颜色
• 描述：输出DEBUG级别的日志到日志窗口。

log_i(msg: str, color: str = 'green')

• 参数：
  • msg: 日志内容
  • color: 日志颜色
• 描述：输出INFO级别的日志到日志窗口。

log_w(msg: str, color: str = 'yellow')

• 参数：
  • msg: 日志内容
  • color: 日志颜色
• 描述：输出WARNING级别的日志到日志窗口。

log_e(msg: str, color: str = 'red')

• 参数：
  • msg: 日志内容
  • color: 日志颜色
• 描述：输出ERROR级别的日志到日志窗口。

scanf(title: str, msg: str, default: str) -> str

• 参数：
  • title: 标题
  • msg: 信息
  • default: 文本框默认内容
• 描述：在start或者loop中调用此函数，会弹出输入框，供用户输入数据。此函数为阻塞式调用，函数返回前，指令不会往下执行。

alert(title: str, msg: str, timeout: int = 3000)

• 参数：
  • title: 标题
  • msg: 信息
  • timeout: 超时后自动关闭，0表示不自动关闭
• 描述：在start或者loop中调用此函数，会弹出消息提示框。此函数为阻塞式调用，函数返回前，指令不会往下执行。

3. 回调函数

start()

• 描述：指令执行时，此函数将被首先执行。此函数运行在指令线程中，可以调用sleep之类的函数，不会阻塞UI界面。
• 注意：此函数必须实现，否则会引起软件异常。

loop()

• 描述：指令执行时，此函数将被循环调用。此函数运行在指令线程中，可以调用sleep之类的函数，不会阻塞UI界面。
• 注意：此函数必须实现，否则会引起软件异常。

recvDataHandler(data: bytearray)

• 参数：
  • data: 接收到的数据
• 描述：当指令对应的接口接收到数据时，此函数被调用。此函数运行在接口线程中，虽然不会阻塞UI界面，但影响接口的数据处理，设计时应快进快出，不要执行特别耗时的操作。
• 注意：此函数必须实现，否则会引起软件异常。