动作类指令

class mini.apis.api_action.PlayAction(is_serial: bool = True, action_name: str | None = None)

基类：BaseApi

执行内置动作api

机器人执行一个指定名称的内置动作 动作名称可用GetActionList获取

参数:

• is_serial (bool) – 是否等待回复，默认True

• action_name (str) – 动作名称，不能为none或空字符串

#PlayActionResponse.isSuccess : 是否成功

#PlayActionResponse.resultCode : 返回码

async execute()

发送执行动作指令

返回:

PlayActionResponse

class mini.apis.api_action.StopAllAction(is_serial: bool = True)

基类：BaseApi

停止所有动作api

停止所有正在执行的动作, 停止指定的自定义动作, 如果动作是一个不可打断的动作, StopCustomActionResponse.resultCode = 403

Args

is_serial (bool): 是否等待回复，默认True

async execute()

发送停止所有动作指令

返回:

StopActionResponse

class mini.apis.api_action.MoveRobotDirection(value)

基类：Enum

机器人移动方向

FORWARD : 向前

BACKWARD : 向后

LEFTWARD : 向左

RIGHTWARD : 向右

FORWARD = 3

BACKWARD = 4

LEFTWARD = 1

RIGHTWARD = 2

class mini.apis.api_action.MoveRobot(is_serial: bool = True, direction: MoveRobotDirection = MoveRobotDirection.FORWARD, step: int = 1)

基类：BaseApi

控制机器人移动api

控制机器人往某个方向(MoveRobotDirection)移动n步

参数:

• is_serial (bool) – 是否等待回复，默认True

• direction (MoveRobotDirection) – 机器人移动方向，默认FORWARD，向前移动

• step (int) – 步数，默认1步

#MoveRobotResponse.isSuccess : 是否成功

#MoveRobotResponse.code : 返回码

async execute()

发送机器人移动指令

返回:

MoveRobotResponse

class mini.apis.api_action.RobotActionType(value)

基类：Enum

机器人动作类型

INNER(内置)：机器人内置的不可修改的动作文件

CUSTOM(自定义): 放置在sdcard/customize/actions目录下可被开发者修改的动作文件

INNER = 0

CUSTOM = 1

class mini.apis.api_action.GetActionList(is_serial: bool = True, action_type: RobotActionType = RobotActionType.INNER)

基类：BaseApi

获取机器人动作列表api

获取存储在机器人本地(内置/自定义)的动作文件列表

参数:

• is_serial (bool) – 是否等待回复，默认True

• action_type (RobotActionType) – 动作类型，默认为INNER，内置动作

#GetActionListResponse.actionList ([str]) : 动作列表，str数组

#GetActionListResponse.isSuccess : 是否成功

#GetActionListResponse.resultCode : 返回码

async execute()

发送获取机器人动作列表指令

返回:

GetActionListResponse

class mini.apis.api_action.PlayCustomAction(is_serial: bool = True, action_name: str | None = None)

基类：BaseApi

执行自定义动作api

让机器人执行一个指定名称的自定义动作 动作名称可用GetActionList获取

参数:

• is_serial (bool) – 是否等待回复，默认True

• action_name (str) – 自定义动作名称，不可为空或者None

#PlayCustomActionResponse.isSuccess : 是否成功

#PlayCustomActionResponse.resultCode : 返回码

async execute()

发送执行自定义动作指令

返回:

PlayCustomActionResponse

class mini.apis.api_action.StopCustomAction(is_serial: bool = True, action_name: str | None = None)

基类：BaseApi

停止自定义动作api

停止指定的自定义动作, 如果动作是一个不可打断的动作, StopCustomActionResponse.resultCode = 403

参数:

• is_serial (bool) – 是否等待回复，默认True

• action_name (str) – 自定义动作名称，不可为空或None

#StopCustomActionResponse.isSuccess : 是否成功

#StopCustomActionResponse.resultCode : 返回码

async execute()

执行停止自定义动作指令

返回:

StopCustomActionResponse