RobotManage (机器人生命周期管理)

RobotManage 更多...

RobotManage (机器人生命周期管理) 的协作图:

函数
int	arcs::common_interface::RobotManage::poweron ()
	发起机器人上电请求
int	arcs::common_interface::RobotManage::startup ()
	发起机器人启动请求
int	arcs::common_interface::RobotManage::releaseRobotBrake ()
	发起机器人松开刹车请求
int	arcs::common_interface::RobotManage::lockRobotBrake ()
	发起机器人刹车请求
int	arcs::common_interface::RobotManage::poweroff ()
	发起机器人断电请求
int	arcs::common_interface::RobotManage::backdrive (bool enable)
	发起机器人反向驱动请求
int	arcs::common_interface::RobotManage::freedrive (bool enable)
	发起机器人自由驱动请求 接口在软件版本 0.31.x 后已废弃，使用 handguideMode 接口替换 handguideMode({1,1,1,1,1}, {0,0,0,0,0,0})
int	arcs::common_interface::RobotManage::setHandguideParams (const std::vector< int > &freeAxes, const std::vector< double > &feature)
	设置拖动示教参数
std::vector< int >	arcs::common_interface::RobotManage::getHandguideFreeAxes ()
	获取拖动轴
std::vector< double >	arcs::common_interface::RobotManage::getHandguideFeature ()
	获取拖动参考坐标系
int	arcs::common_interface::RobotManage::handguideMode (const std::vector< int > &freeAxes, const std::vector< double > &feature)
	高阶拖动示教
int	arcs::common_interface::RobotManage::exitHandguideMode ()
	退出拖动示教
int	arcs::common_interface::RobotManage::getHandguideStatus ()
	获取拖动示教器的状态（是否处于奇异空间）
int	arcs::common_interface::RobotManage::getHandguideTrigger ()
	获取拖动示教器触发源
bool	arcs::common_interface::RobotManage::isHandguideEnabled ()
	获取拖动示教使能状态
int	arcs::common_interface::RobotManage::setSim (bool enable)
	发起机器人进入/退出仿真模式请求
int	arcs::common_interface::RobotManage::setOperationalMode (OperationalModeType mode)
	设置机器人操作模式
OperationalModeType	arcs::common_interface::RobotManage::getOperationalMode ()
	获取机器人操作模式
RobotControlModeType	arcs::common_interface::RobotManage::getRobotControlMode ()
	获取控制模式
bool	arcs::common_interface::RobotManage::isFreedriveEnabled ()
	是否使能了拖动示教模式
bool	arcs::common_interface::RobotManage::isBackdriveEnabled ()
	是否使能了反向驱动模式
bool	arcs::common_interface::RobotManage::isSimulationEnabled ()
	是否使能了仿真模式
int	arcs::common_interface::RobotManage::setUnlockProtectiveStop ()
	清除防护停机，包括碰撞停机
int	arcs::common_interface::RobotManage::restartInterfaceBoard ()
	重置安全接口板，一般在机器人断电之后需要重置时调用，比如机器人急停、故障等之后
int	arcs::common_interface::RobotManage::recordCacheFree (const std::string &name)
	释放并清空指定内存缓存的记录数据
int	arcs::common_interface::RobotManage::startRecordCache (const std::string &name)
	开始实时轨迹的内存缓存记录（不落盘）
int	arcs::common_interface::RobotManage::stopRecordCache ()
	停止当前实时轨迹内存缓存记录
int	arcs::common_interface::RobotManage::pauseRecordCache (bool pause)
	暂停/恢复当前实时轨迹内存缓存记录
int	arcs::common_interface::RobotManage::getRecordCache (const std::string &name, size_t frames=0)
	获取指定内存缓存的记录数据
int	arcs::common_interface::RobotManage::startRecord (const std::string &file_name)
	开始实时轨迹的记录
int	arcs::common_interface::RobotManage::stopRecord ()
	停止实时记录
int	arcs::common_interface::RobotManage::pauseRecord (bool pause)
	暂停实时记录
int	arcs::common_interface::RobotManage::setLinkModeEnable (bool enable)
	发起机器人进入/退出联动模式请求, 只有操作模式为自动或者无时，才能使能联动模式
bool	arcs::common_interface::RobotManage::isLinkModeEnabled ()
	是否使能了联动模式，联动模式下用户可以通过外部IO控制机器人（用户可以对IO的功能进行配置）
int	arcs::common_interface::RobotManage::generateDiagnoseFile (const std::string &reason)
	手动触发生成诊断文件

详细描述

RobotManage

函数说明

backdrive()

int arcs::common_interface::RobotManage::backdrive

(

bool

enable

)

发起机器人反向驱动请求

参数

enable

返回

成功返回0; 失败返回错误码 AUBO_BUSY AUBO_BAD_STATE -AUBO_INVL_ARGUMENT -AUBO_BAD_STATE

异常

arcs::common_interface::AuboException

Python函数原型

backdrive(self: pyaubo_sdk.RobotManage, arg0: bool) -> int

Lua函数原型

backdrive(enable: boolean) -> number

Lua示例

num = backdrive(false)

JSON-RPC请求示例

{"jsonrpc":"2.0","method":"rob1.RobotManage.backdrive","params":[false],"id":1}

JSON-RPC响应示例

{"id":1,"jsonrpc":"2.0","result":0}

C++示例

auto rpc_cli = std::make_shared<RpcClient>();
auto robot_name = rpc_cli->getRobotNames().front();
rpc_cli->getRobotInterface(robot_name)->getRobotManage()->backdrive(true);

exitHandguideMode()

int arcs::common_interface::RobotManage::exitHandguideMode

(

)

退出拖动示教

注解

需 0.31.x 及以后软件版本

返回

成功返回0; 失败返回错误码 AUBO_BUSY AUBO_BAD_STATE -AUBO_BAD_STATE

异常

arcs::common_interface::AuboException

freedrive()

int arcs::common_interface::RobotManage::freedrive

(

bool

enable

)

发起机器人自由驱动请求 接口在软件版本 0.31.x 后已废弃，使用 handguideMode 接口替换 handguideMode({1,1,1,1,1}, {0,0,0,0,0,0})

参数

enable

返回

成功返回0; 失败返回错误码 AUBO_BUSY AUBO_BAD_STATE -AUBO_INVL_ARGUMENT -AUBO_BAD_STATE

异常

arcs::common_interface::AuboException

Python函数原型

freedrive(self: pyaubo_sdk.RobotManage, arg0: bool) -> int

Lua函数原型

freedrive(enable: boolean) -> number

Lua示例

num = freedrive(false)

JSON-RPC请求示例

{"jsonrpc":"2.0","method":"rob1.RobotManage.freedrive","params":[true],"id":1}

JSON-RPC响应示例

{"id":1,"jsonrpc":"2.0","result":0}

C++示例

auto rpc_cli = std::make_shared<RpcClient>();
auto robot_name = rpc_cli->getRobotNames().front();
rpc_cli->getRobotInterface(robot_name)->getRobotManage()->freedrive(true);

generateDiagnoseFile()

int arcs::common_interface::RobotManage::generateDiagnoseFile

(

const std::string &

reason

)

手动触发生成诊断文件

返回

指令下发成功返回0; 失败返回错误码。
-AUBO_BAD_STATE: 运行时(RuntimeMachine)的当前状态不是Stopped, 固件升级请求被拒绝。AUBO_BAD_STATE的值是1。
-AUBO_TIMEOUT: 超时。AUBO_TIMEOUT的值是4。

异常

arcs::common_interface::AuboException

Python函数原型

generateDiagnoseFile(self: pyaubo_sdk.RobotManage, arg0: str) -> int

Lua函数原型

generateDiagnoseFile(reason: string) -> nil

Lua示例

generateDiagnoseFile("reason")

JSON-RPC请求示例

{"jsonrpc":"2.0","method":"rob1.RobotManage.generateDiagnoseFile","params":["reason"],"id":1}

JSON-RPC响应示例

{"id":1,"jsonrpc":"2.0","result":false}

C++示例

auto rpc_cli = std::make_shared<RpcClient>();
auto robot_name = rpc_cli->getRobotNames().front();
bool isEnabled =
rpc_cli->getRobotInterface(robot_name)->getRobotManage()->generateDiagnoseFile("reason");

getHandguideFeature()

std::vector< double > arcs::common_interface::RobotManage::getHandguideFeature

(

)

获取拖动参考坐标系

getHandguideFreeAxes()

std::vector< int > arcs::common_interface::RobotManage::getHandguideFreeAxes

(

)

获取拖动轴

getHandguideStatus()

int arcs::common_interface::RobotManage::getHandguideStatus

(

)

获取拖动示教器的状态（是否处于奇异空间）

注解

暂未实现

返回

• 0 - 正常操作. • 1 - 接近奇异空间. • 2 - 极其接近奇异点，将产生较大的拖动阻尼.

异常

arcs::common_interface::AuboException

getHandguideTrigger()

int arcs::common_interface::RobotManage::getHandguideTrigger

(

)

获取拖动示教器触发源

注解

暂未实现

返回

异常

arcs::common_interface::AuboException

getOperationalMode()

OperationalModeType arcs::common_interface::RobotManage::getOperationalMode

(

)

获取机器人操作模式

返回

机器人操作模式

异常

arcs::common_interface::AuboException

Python函数原型

getOperationalMode(self: pyaubo_sdk.RobotManage) -> arcs::common_interface::OperationalModeType

Lua函数原型

getOperationalMode() -> number

Lua示例

num = getOperationalMode()

JSON-RPC请求示例

{"jsonrpc":"2.0","method":"rob1.RobotManage.getOperationalMode","params":[],"id":1}

JSON-RPC响应示例

{"id":1,"jsonrpc":"2.0","result":"Manual"}

C++示例

auto rpc_cli = std::make_shared<RpcClient>();
auto robot_name = rpc_cli->getRobotNames().front();
OperationalModeType mode =
rpc_cli->getRobotInterface(robot_name)->getRobotManage()->getOperationalMode();

getRecordCache()

int arcs::common_interface::RobotManage::getRecordCache	(	const std::string &	name,
		size_t	frames = 0 )

获取指定内存缓存的记录数据

参数

name	缓存名称
frames	获取帧数上限： frames=0：获取全部已记录帧（1帧=1周期） frames>0：最多获取最近 frames 帧

返回

成功返回获取到的帧数（>=0）；失败返回错误码（<0）

异常

arcs::common_interface::AuboException

Lua函数原型

getRecordCache(name: string, frames: number = 0) -> number

Lua示例

n = getRecordCache("rec") – 获取全部，返回帧数 n = getRecordCache("rec", 2000) – 获取最近2000帧，返回帧数

getRobotControlMode()

RobotControlModeType arcs::common_interface::RobotManage::getRobotControlMode

(

)

获取控制模式

返回

控制模式

异常

arcs::common_interface::AuboException

Python函数原型

getRobotControlMode(self: pyaubo_sdk.RobotManage) -> arcs::common_interface::RobotControlModeType

Lua函数原型

getRobotControlMode() -> number

Lua示例

num = getRobotControlMode()

JSON-RPC请求示例

{"jsonrpc":"2.0","method":"rob1.RobotManage.getRobotControlMode","params":[],"id":1}

JSON-RPC响应示例

{"id":1,"jsonrpc":"2.0","result":"Position"}

C++示例

auto rpc_cli = std::make_shared<RpcClient>();
auto robot_name = rpc_cli->getRobotNames().front();
RobotControlModeType mode =
rpc_cli->getRobotInterface(robot_name)->getRobotManage()->getRobotControlMode();

handguideMode()

int arcs::common_interface::RobotManage::handguideMode	(	const std::vector< int > &	freeAxes,
		const std::vector< double > &	feature )

高阶拖动示教

参数

freeAxes	可以拖动的轴 0-不能拖动 1-可以拖动
feature	如果维度为0，代表基于 TCP 坐标系拖动

返回

成功返回0; 失败返回错误码 AUBO_BUSY AUBO_BAD_STATE -AUBO_INVL_ARGUMENT -AUBO_BAD_STATE

异常

arcs::common_interface::AuboException

isBackdriveEnabled()

bool arcs::common_interface::RobotManage::isBackdriveEnabled

(

)

是否使能了反向驱动模式

返回

使能返回true; 反之返回false

异常

arcs::common_interface::AuboException

Python函数原型

isBackdriveEnabled(self: pyaubo_sdk.RobotManage) -> bool

Lua函数原型

isBackdriveEnabled() -> boolean

Lua示例

BackdriveEnabled = isBackdriveEnabled()

JSON-RPC请求示例

{"jsonrpc":"2.0","method":"rob1.RobotManage.isBackdriveEnabled","params":[],"id":1}

JSON-RPC响应示例

{"id":1,"jsonrpc":"2.0","result":false}

C++示例

auto rpc_cli = std::make_shared<RpcClient>();
auto robot_name = rpc_cli->getRobotNames().front();
bool isEnabled =
rpc_cli->getRobotInterface(robot_name)->getRobotManage()->isBackdriveEnabled();

isFreedriveEnabled()

bool arcs::common_interface::RobotManage::isFreedriveEnabled

(

)

是否使能了拖动示教模式

返回

使能返回true; 反之返回false

异常

arcs::common_interface::AuboException

Python函数原型

isFreedriveEnabled(self: pyaubo_sdk.RobotManage) -> bool

Lua函数原型

isFreedriveEnabled() -> boolean

Lua示例

FreedriveEnabled = isFreedriveEnabled()

JSON-RPC请求示例

{"jsonrpc":"2.0","method":"rob1.RobotManage.isFreedriveEnabled","params":[],"id":1}

JSON-RPC响应示例

{"id":1,"jsonrpc":"2.0","result":false}

C++示例

auto rpc_cli = std::make_shared<RpcClient>();
auto robot_name = rpc_cli->getRobotNames().front();
bool isEnabled =
rpc_cli->getRobotInterface(robot_name)->getRobotManage()->isFreedriveEnabled();

isHandguideEnabled()

bool arcs::common_interface::RobotManage::isHandguideEnabled

(

)

获取拖动示教使能状态

返回

使能返回true; 失能返回false

异常

arcs::common_interface::AuboException

Lua函数原型

isHandguideEnabled() -> boolean

Lua示例

Handguide = isHandguideEnabled()

JSON-RPC请求示例

{"jsonrpc":"2.0","method":"rob1.RobotManage.isHandguideEnabled","params":[],"id":1}

JSON-RPC响应示例

{"id":1,"jsonrpc":"2.0","result":false}

isLinkModeEnabled()

bool arcs::common_interface::RobotManage::isLinkModeEnabled

(

)

是否使能了联动模式，联动模式下用户可以通过外部IO控制机器人（用户可以对IO的功能进行配置）

返回

使能返回true; 反之返回false

异常

arcs::common_interface::AuboException

Python函数原型

isLinkModeEnabled(self: pyaubo_sdk.RobotManage) -> bool

Lua函数原型

isLinkModeEnabled() -> boolean

Lua示例

LinkModeEnabled = isLinkModeEnabled()

JSON-RPC请求示例

{"jsonrpc":"2.0","method":"rob1.RobotManage.isLinkModeEnabled","params":[],"id":1}

JSON-RPC响应示例

{"id":1,"jsonrpc":"2.0","result":false}

C++示例

auto rpc_cli = std::make_shared<RpcClient>();
auto robot_name = rpc_cli->getRobotNames().front();
bool isEnabled =
rpc_cli->getRobotInterface(robot_name)->getRobotManage()->isLinkModeEnabled();

isSimulationEnabled()

bool arcs::common_interface::RobotManage::isSimulationEnabled

(

)

是否使能了仿真模式

返回

使能返回true; 反之返回false

异常

arcs::common_interface::AuboException

Python函数原型

isSimulationEnabled(self: pyaubo_sdk.RobotManage) -> bool

Lua函数原型

isSimulationEnabled() -> boolean

Lua示例

SimulationEnabled = isSimulationEnabled()

JSON-RPC请求示例

{"jsonrpc":"2.0","method":"rob1.RobotManage.isSimulationEnabled","params":[],"id":1}

JSON-RPC响应示例

{"id":1,"jsonrpc":"2.0","result":true}

C++示例

auto rpc_cli = std::make_shared<RpcClient>();
auto robot_name = rpc_cli->getRobotNames().front();
bool isEnabled =
rpc_cli->getRobotInterface(robot_name)->getRobotManage()->isSimulationEnabled();

lockRobotBrake()

int arcs::common_interface::RobotManage::lockRobotBrake

(

)

发起机器人刹车请求

返回

成功返回0; 失败返回错误码 AUBO_BAD_STATE

异常

arcs::common_interface::AuboException

Python函数原型

lockRobotBrake(self: pyaubo_sdk.RobotManage) -> int

Lua函数原型

lockRobotBrake() -> number

Lua示例

num = lockRobotBrake()

JSON-RPC请求示例

{"jsonrpc":"2.0","method":"rob1.RobotManage.lockRobotBrake","params":[],"id":1}

JSON-RPC响应示例

{"id":1,"jsonrpc":"2.0","result":0}

C++示例

auto rpc_cli = std::make_shared<RpcClient>();
auto robot_name = rpc_cli->getRobotNames().front();
rpc_cli->getRobotInterface(robot_name)->getRobotManage()->lockRobotBrake();

pauseRecord()

int arcs::common_interface::RobotManage::pauseRecord

(

bool

pause

)

暂停实时记录

参数

pause

返回

成功返回0；失败返回错误码 AUBO_BUSY AUBO_BAD_STATE -AUBO_BAD_STATE

异常

arcs::common_interface::AuboException

JSON-RPC请求示例

{"jsonrpc":"2.0","method":"rob1.RobotManage.pauseRecord","params":[true],"id":1}

JSON-RPC响应示例

{"id":1,"jsonrpc":"2.0","result":0}

pauseRecordCache()

int arcs::common_interface::RobotManage::pauseRecordCache

(

bool

pause

)

暂停/恢复当前实时轨迹内存缓存记录

参数

pause

true：暂停缓存记录；false：恢复缓存记录

返回

成功返回0；失败返回错误码（<0）

异常

arcs::common_interface::AuboException

Lua函数原型

pauseRecordCache(pause: boolean) -> nil

Lua示例

pauseRecordCache(true) – 暂停 pauseRecordCache(false) – 恢复

poweroff()

int arcs::common_interface::RobotManage::poweroff

(

)

发起机器人断电请求

返回

成功返回0; 失败返回错误码 AUBO_BAD_STATE

异常

arcs::common_interface::AuboException

Python函数原型

poweroff(self: pyaubo_sdk.RobotManage) -> int

Lua函数原型

poweroff() -> number

Lua示例

num = poweroff()

JSON-RPC请求示例

{"jsonrpc":"2.0","method":"rob1.RobotManage.poweroff","params":[],"id":1}

JSON-RPC响应示例

{"id":1,"jsonrpc":"2.0","result":0}

C++示例

auto rpc_cli = std::make_shared<RpcClient>();
auto robot_name = rpc_cli->getRobotNames().front();
rpc_cli->getRobotInterface(robot_name)->getRobotManage()->poweroff();

poweron()

int arcs::common_interface::RobotManage::poweron

(

)

发起机器人上电请求

返回

成功返回0; 失败返回错误码 AUBO_BAD_STATE

异常

arcs::common_interface::AuboException

Python函数原型

poweron(self: pyaubo_sdk.RobotManage) -> int

Lua函数原型

poweron() -> number

Lua示例

num = poweron()

JSON-RPC请求示例

{"jsonrpc":"2.0","method":"rob1.RobotManage.poweron","params":[],"id":1}

JSON-RPC响应示例

{"id":1,"jsonrpc":"2.0","result":0}

C++ 实例

auto rpc_cli = std::make_shared<RpcClient>();
auto robot_name = rpc_cli->getRobotNames().front();
rpc_cli->getRobotInterface(robot_name)->getRobotManage()->poweron();

recordCacheFree()

int arcs::common_interface::RobotManage::recordCacheFree

(

const std::string &

name

)

释放并清空指定内存缓存的记录数据

参数

name

缓存名称

返回

成功返回0；失败返回错误码（<0）

异常

arcs::common_interface::AuboException

Lua函数原型

recordCacheFree(name: string) -> nil

Lua示例

recordCacheFree("rec")

releaseRobotBrake()

int arcs::common_interface::RobotManage::releaseRobotBrake

(

)

发起机器人松开刹车请求

返回

成功返回0; 失败返回错误码 AUBO_BAD_STATE

异常

arcs::common_interface::AuboException

Python函数原型

releaseRobotBrake(self: pyaubo_sdk.RobotManage) -> int

Lua函数原型

releaseRobotBrake() -> number

Lua示例

num = releaseRobotBrake()

JSON-RPC请求示例

{"jsonrpc":"2.0","method":"rob1.RobotManage.releaseRobotBrake","params":[],"id":1}

JSON-RPC响应示例

{"id":1,"jsonrpc":"2.0","result":0}

C++示例

auto rpc_cli = std::make_shared<RpcClient>();
auto robot_name = rpc_cli->getRobotNames().front();
rpc_cli->getRobotInterface(robot_name)->getRobotManage()->releaseRobotBrake();

restartInterfaceBoard()

int arcs::common_interface::RobotManage::restartInterfaceBoard

(

)

重置安全接口板，一般在机器人断电之后需要重置时调用，比如机器人急停、故障等之后

返回

成功返回0; 失败返回错误码 AUBO_BUSY AUBO_BAD_STATE -AUBO_BAD_STATE

异常

arcs::common_interface::AuboException

Python函数原型

restartInterfaceBoard(self: pyaubo_sdk.RobotManage) -> int

Lua函数原型

restartInterfaceBoard() -> number

Lua示例

num = restartInterfaceBoard()

JSON-RPC请求示例

{"jsonrpc":"2.0","method":"rob1.RobotManage.restartInterfaceBoard","params":[],"id":1}

JSON-RPC响应示例

{"id":1,"jsonrpc":"2.0","result":0}

C++示例

auto rpc_cli = std::make_shared<RpcClient>();
auto robot_name = rpc_cli->getRobotNames().front();
rpc_cli->getRobotInterface(robot_name)->getRobotManage()->restartInterfaceBoard();

setHandguideParams()

int arcs::common_interface::RobotManage::setHandguideParams	(	const std::vector< int > &	freeAxes,
		const std::vector< double > &	feature )

设置拖动示教参数

参数

freeAxes	可以拖动的轴 0-不能拖动 1-可以拖动
feature	如果维度为0，代表基于 TCP 坐标系拖动

返回

成功返回0; 失败返回错误码 AUBO_BUSY AUBO_BAD_STATE -AUBO_INVL_ARGUMENT -AUBO_BAD_STATE

异常

arcs::common_interface::AuboException

setLinkModeEnable()

int arcs::common_interface::RobotManage::setLinkModeEnable

(

bool

enable

)

发起机器人进入/退出联动模式请求, 只有操作模式为自动或者无时，才能使能联动模式

参数

enable

返回

成功返回0; 失败返回错误码 AUBO_BUSY AUBO_REQUEST_IGNORE -AUBO_BAD_STATE

异常

arcs::common_interface::AuboException

Python函数原型

setLinkModeEnable(self: pyaubo_sdk.RobotManage, arg0: bool) -> int

Lua函数原型

setLinkModeEnable(enable: boolean) -> number

Lua示例

num = setLinkModeEnable(true)

JSON-RPC请求示例

{"jsonrpc":"2.0","method":"rob1.RobotManage.setLinkModeEnable","params":[true],"id":1}

JSON-RPC响应示例

{"id":1,"jsonrpc":"2.0","result":0}

C++示例

auto rpc_cli = std::make_shared<RpcClient>();
auto robot_name = rpc_cli->getRobotNames().front();
rpc_cli->getRobotInterface(robot_name)->getRobotManage()->setLinkModeEnable(true);

setOperationalMode()

int arcs::common_interface::RobotManage::setOperationalMode

(

OperationalModeType

mode

)

设置机器人操作模式

参数

mode

操作模式

返回

成功返回0; 失败返回错误码 -AUBO_BAD_STATE

异常

arcs::common_interface::AuboException

Python函数原型

setOperationalMode(self: pyaubo_sdk.RobotManage, arg0: arcs::common_interface::OperationalModeType) -> int

Lua函数原型

setOperationalMode(mode: number) -> number

Lua示例

num = setOperationalMode("Manual")

JSON-RPC请求示例

{"jsonrpc":"2.0","method":"rob1.RobotManage.setOperationalMode","params":["Manual"],"id":1}

JSON-RPC响应示例

{"id":1,"jsonrpc":"2.0","result":0}

C++示例

auto rpc_cli = std::make_shared<RpcClient>();
auto robot_name = rpc_cli->getRobotNames().front();
rpc_cli->getRobotInterface(robot_name)->getRobotManage()->setOperationalMode(OperationalModeType::Automatic);

setSim()

int arcs::common_interface::RobotManage::setSim

(

bool

enable

)

发起机器人进入/退出仿真模式请求

参数

enable

返回

成功返回0；失败返回错误码 AUBO_BUSY AUBO_BAD_STATE -AUBO_INVL_ARGUMENT -AUBO_BAD_STATE

异常

arcs::common_interface::AuboException

Python函数原型

setSim(self: pyaubo_sdk.RobotManage, arg0: bool) -> int

Lua函数原型

setSim(enable: boolean) -> number

Lua示例

num = setSim(true)

JSON-RPC请求示例

{"jsonrpc":"2.0","method":"rob1.RobotManage.setSim","params":[true],"id":1}

JSON-RPC响应示例

{"id":1,"jsonrpc":"2.0","result":0}

C++示例

auto rpc_cli = std::make_shared<RpcClient>();
auto robot_name = rpc_cli->getRobotNames().front();
rpc_cli->getRobotInterface(robot_name)->getRobotManage()->setSim(true);

setUnlockProtectiveStop()

int arcs::common_interface::RobotManage::setUnlockProtectiveStop

(

)

清除防护停机，包括碰撞停机

返回

成功返回0；失败返回错误码 AUBO_BUSY AUBO_BAD_STATE -AUBO_BAD_STATE

异常

arcs::common_interface::AuboException

Python函数原型

setUnlockProtectiveStop(self: pyaubo_sdk.RobotManage) -> int

Lua函数原型

setUnlockProtectiveStop() -> number

Lua示例

num = setUnlockProtectiveStop()

JSON-RPC请求示例

{"jsonrpc":"2.0","method":"rob1.RobotManage.setUnlockProtectiveStop","params":[],"id":1}

JSON-RPC响应示例

{"id":1,"jsonrpc":"2.0","result":0}

C++示例

auto rpc_cli = std::make_shared<RpcClient>();
auto robot_name = rpc_cli->getRobotNames().front();
rpc_cli->getRobotInterface(robot_name)->getRobotManage()->setUnlockProtectiveStop();

startRecord()

int arcs::common_interface::RobotManage::startRecord

(

const std::string &

file_name

)

开始实时轨迹的记录

参数

file_name

返回

成功返回0；失败返回错误码 AUBO_BUSY AUBO_BAD_STATE -AUBO_INVL_ARGUMENT -AUBO_BAD_STATE

异常

arcs::common_interface::AuboException

Lua函数原型

startRecord(fiel_name: string) -> nil

Lua示例

startRecord("traje.csv")

startRecordCache()

int arcs::common_interface::RobotManage::startRecordCache

(

const std::string &

name

)

开始实时轨迹的内存缓存记录（不落盘）

参数

name	缓存名称（用于索引内存中的记录数据）。空字符串将返回参数错误。

返回

成功返回0；失败返回错误码（<0）

异常

arcs::common_interface::AuboException

Lua函数原型

startRecordCache(name: string) -> nil

Lua示例

startRecordCache("rec")

startup()

int arcs::common_interface::RobotManage::startup

(

)

发起机器人启动请求

返回

成功返回0; 失败返回错误码 AUBO_BAD_STATE

异常

arcs::common_interface::AuboException

Python函数原型

startup(self: pyaubo_sdk.RobotManage) -> int

Lua函数原型

startup() -> number

Lua示例

num = startup()

JSON-RPC请求示例

{"jsonrpc":"2.0","method":"rob1.RobotManage.startup","params":[],"id":1}

JSON-RPC响应示例

{"id":1,"jsonrpc":"2.0","result":0}

C++示例

auto rpc_cli = std::make_shared<RpcClient>();
auto robot_name = rpc_cli->getRobotNames().front();
rpc_cli->getRobotInterface(robot_name)->getRobotManage()->startup();

stopRecord()

int arcs::common_interface::RobotManage::stopRecord

(

)

停止实时记录

返回

成功返回0；失败返回错误码 AUBO_BUSY AUBO_BAD_STATE -AUBO_BAD_STATE

异常

arcs::common_interface::AuboException

Lua函数原型

stopRecord() -> nil

Lua示例

stopRecord()

JSON-RPC请求示例

{"jsonrpc":"2.0","method":"rob1.RobotManage.stopRecord","params":[],"id":1}

JSON-RPC响应示例

{"id":1,"jsonrpc":"2.0","result":0}

stopRecordCache()

int arcs::common_interface::RobotManage::stopRecordCache

(

)

停止当前实时轨迹内存缓存记录

返回

成功返回0；失败返回错误码（<0）

异常

arcs::common_interface::AuboException

Lua函数原型

stopRecordCache() -> nil

Lua示例

stopRecordCache()