System (系统模块)

函数
int	agvc_interface::AgvcInterface::setSystemClock (const std::string &stamp)
	设置AGV系统时间。 时间戳，格式为YYYY-MM-DDTHH:mm:ss.ssZ，例如“2017-04-15T11:40:03.12Z”。
AsyncInterfaceResultStatus	agvc_interface::AgvcInterface::getAsyncInterfaceResultStatus ()
	查询异步接口的运行情况，不代表异步接口本身的运行结果。 异步接口：saveMap, switchMap, changeRunningMode, relocation, sendBase64PngMapToAgv。 异步接口：getGridMapAllInfo, setGridMapAllInfo, sendGridMapToAgv, getGridMapFromAgv。 异步接口：getPngMapAllInfo, setPngMapAllInfo, getBase64PngMapFromAgv, previewPngMapFromAgv。 异步接口：autoAlignRailway。 客户端与AGV断联后，可调用该接口获取异步接口运行情况。 返回值的每个字段中均有header，其中header.id表示下发异步任务时的id号。 NONE：异步接口未运行；RUNNING：异步接口运行中；FINISH：异步接口运行结束。
std::vector< std::string >	agvc_interface::AgvcInterface::getWifiList ()
int	agvc_interface::AgvcInterface::connectWifi (const std::string &ssid, const std::string &password)
	连接到指定WiFi，自动切换到WiFi模式。 必须在有线连接时调用，且执行时间较长。 WiFi名称。 WiFi密码。 10100000：连接WiFi成功；else：连接WiFi失败。
int	agvc_interface::AgvcInterface::enableHotspot (const std::string &password)
	开启热点，自动切换到热点模式。 必须在有线连接时调用，且执行时间较长。 热点密码；如果为空使用"administrator"为默认密码，SSID默认为SN码。 10100000：启用热点成功；else：启用热点失败。
std::vector< IpAddressInfo >	agvc_interface::AgvcInterface::getIpAddressList ()
	获取本机所有IP地址。 本机所有IP地址。
std::string	agvc_interface::AgvcInterface::getAgvControllerParametersFile ()
	获取AGV控制器的参数文件。 当前AGV控制器中的参数信息。
int	agvc_interface::AgvcInterface::setAgvControllerParametersFile (const std::string &agv_parameters)
int	agvc_interface::AgvcInterface::refreshAgvControllerParametersFile ()
int	agvc_interface::AgvcInterface::resetAgvControllerParametersFile ()
int	agvc_interface::AgvcInterface::updateSoftware (const std::string &upgrade_pack_path)
	AGV软件升级。 升级包路径，例如"/root/agvc_release-0.1.1+398d1f7-Linux_x86_64.tar.gz"。 10100000：目标版本升级成功；10100201：正在升级中；else：升级失败。
std::vector< std::string >	agvc_interface::AgvcInterface::getSoftwareVersionList ()
	获取AGV软件版本列表。 软件版本列表集合 {0.3.2+3b807d1-Linux_x86_64,0.6.3-patch.3+b8c6aa4-Linux_x86_64}。
int	agvc_interface::AgvcInterface::switchSoftwareVersion (const std::string &software_version)
	切换AGV软件版本。 软件版本，例如"0.3.2+3b807d1-Linux_x86_64"。 10100000：软件版本切换成功；else：软件版本切换失败。
int	agvc_interface::AgvcInterface::uninstallSoftware (const std::string &software_version)
	卸载AGV软件版本。 软件版本，例如"0.3.2+3b807d1-Linux_x86_64"。 10100000：软件版本卸载成功；else：软件版本卸载失败。
int	agvc_interface::AgvcInterface::updateFirmware (const FirmwareUpdateParam &update_firmware)
	AGV固件更新。 配置要更新固件的模块、固件存储路径。 10100000：下发固件更新信息成功；else：固件正在更新中。
FirmwareUpdateProcessInfo	agvc_interface::AgvcInterface::getUpdateFirmwareProcess ()
	获取固件更新过程信息。 固件更新步骤信息(步骤信息为failed代表更新失败)，更新进度(进度信息为1.0代表更新成功)。
int	agvc_interface::AgvcInterface::startCollectCalibrationData (const CalibrationType &type, const Header &command_header={ "99999", "99999", 1, "99999" })
	开始采集数据。 LASER_ODOM标定采集数据量要求大于1000组，具体数据量可以在配置文件中修改。 标定类型。 id字段代表下发本次命令的id；其他字段无特殊含义。 10100000：接口调用成功；10120202：无控制权；else：接口调用失败。
int	agvc_interface::AgvcInterface::cancelCollectCalibrationData (const CalibrationType &type, const Header &command_header={ "99999", "99999", 1, "99999" })
	取消采集数据。 标定类型。 id字段代表下发本次命令的id；其他字段无特殊含义。 10100000：接口调用成功；10120202：无控制权；else：接口调用失败。
int	agvc_interface::AgvcInterface::startCalibration (const CalibrationType &type, const Header &command_header={ "99999", "99999", 1, "99999" })
	开始标定。 标定类型。 id字段代表下发本次命令的id；其他字段无特殊含义。 10100000：接口调用成功；10120202：无控制权；else：接口调用失败。
CalibrationProcessInfo	agvc_interface::AgvcInterface::getCalibrationProcessInfo (const CalibrationType &type)
	获取标定信息。 标定类型。 标定信息。
int	agvc_interface::AgvcInterface::restartAgv ()
	重启AGV。 10100000：重启指令执行成功；else：重启指令执行失败。
int	agvc_interface::AgvcInterface::setAgvName (const std::string &agv_name)
	设置AGV的名称。 设置的AGV名称。 10100000：设置名称成功；else：设置名称失败。
int	agvc_interface::AgvcInterface::setPriority (const std::string &name, const std::string &ip="")
	设置控制权。 1.
int	agvc_interface::AgvcInterface::releasePriority ()
	释放控制权。 10100000：释放控制权成功；else：释放控制权失败。
int	agvc_interface::AgvcInterface::scriptPaused ()
	暂停脚本。 10100000：脚本暂停成功；else：脚本暂停失败。
int	agvc_interface::AgvcInterface::scriptResume ()
	恢复脚本。 10100000：脚本恢复成功；else：脚本恢复失败。
int	agvc_interface::AgvcInterface::scriptStop ()
	停止脚本。 10100000：脚本停止成功；else：脚本停止失败。
int	agvc_interface::AgvcInterface::setScriptStatus (ScriptRuntimeState status)
	设置脚本运行状态。 10100000：设置脚本运行状态成功；else：设置脚本运行状态失败。
int	agvc_interface::AgvcInterface::autoAlignRailway (const Header &command_header={ "99999", "99999", 1, "99999" })

详细描述

AGVC系统配置、控制权、软件升级、固件更新等系统级功能

函数说明

autoAlignRailway()

int agvc_interface::AgvcInterface::autoAlignRailway

(

const Header &

command_header = { "99999", "99999", 1, "99999" }

)

注意

1.异步接口；2.控制权限制。 自动对接轨道并上轨。 id字段代表下发本次命令的id；其他字段无特殊含义。 10100000：自动上轨成功；10100201：正在上轨中；10120202：无控制权；else：上轨失败。

cancelCollectCalibrationData()

int agvc_interface::AgvcInterface::cancelCollectCalibrationData	(	const CalibrationType &	type,
		const Header &	command_header = { "99999", "99999", 1, "99999" } )

取消采集数据。 标定类型。 id字段代表下发本次命令的id；其他字段无特殊含义。 10100000：接口调用成功；10120202：无控制权；else：接口调用失败。

connectWifi()

int agvc_interface::AgvcInterface::connectWifi	(	const std::string &	ssid,
		const std::string &	password )

连接到指定WiFi，自动切换到WiFi模式。 必须在有线连接时调用，且执行时间较长。 WiFi名称。 WiFi密码。 10100000：连接WiFi成功；else：连接WiFi失败。

enableHotspot()

int agvc_interface::AgvcInterface::enableHotspot

(

const std::string &

password

)

开启热点，自动切换到热点模式。 必须在有线连接时调用，且执行时间较长。 热点密码；如果为空使用"administrator"为默认密码，SSID默认为SN码。 10100000：启用热点成功；else：启用热点失败。

getAgvControllerParametersFile()

std::string agvc_interface::AgvcInterface::getAgvControllerParametersFile

(

)

获取AGV控制器的参数文件。 当前AGV控制器中的参数信息。

getAsyncInterfaceResultStatus()

AsyncInterfaceResultStatus agvc_interface::AgvcInterface::getAsyncInterfaceResultStatus

(

)

查询异步接口的运行情况，不代表异步接口本身的运行结果。 异步接口：saveMap, switchMap, changeRunningMode, relocation, sendBase64PngMapToAgv。 异步接口：getGridMapAllInfo, setGridMapAllInfo, sendGridMapToAgv, getGridMapFromAgv。 异步接口：getPngMapAllInfo, setPngMapAllInfo, getBase64PngMapFromAgv, previewPngMapFromAgv。 异步接口：autoAlignRailway。 客户端与AGV断联后，可调用该接口获取异步接口运行情况。 返回值的每个字段中均有header，其中header.id表示下发异步任务时的id号。 NONE：异步接口未运行；RUNNING：异步接口运行中；FINISH：异步接口运行结束。

getCalibrationProcessInfo()

CalibrationProcessInfo agvc_interface::AgvcInterface::getCalibrationProcessInfo

(

const CalibrationType &

type

)

获取标定信息。 标定类型。 标定信息。

getIpAddressList()

std::vector< IpAddressInfo > agvc_interface::AgvcInterface::getIpAddressList

(

)

获取本机所有IP地址。 本机所有IP地址。

getSoftwareVersionList()

std::vector< std::string > agvc_interface::AgvcInterface::getSoftwareVersionList

(

)

获取AGV软件版本列表。 软件版本列表集合 {0.3.2+3b807d1-Linux_x86_64,0.6.3-patch.3+b8c6aa4-Linux_x86_64}。

getUpdateFirmwareProcess()

FirmwareUpdateProcessInfo agvc_interface::AgvcInterface::getUpdateFirmwareProcess

(

)

获取固件更新过程信息。 固件更新步骤信息(步骤信息为failed代表更新失败)，更新进度(进度信息为1.0代表更新成功)。

getWifiList()

std::vector< std::string > agvc_interface::AgvcInterface::getWifiList

(

)

注意

异步接口。 获取当前扫描到的WiFi列表。 {RUNNING}：异步接口运行中；{}：为空，未扫描到WIFI；{SSID}：不为空，扫描到的WIFI名称列表。

refreshAgvControllerParametersFile()

int agvc_interface::AgvcInterface::refreshAgvControllerParametersFile

(

)

注意

控制权限制。 修改AGV控制器的参数文件后，让AGV各节点刷新参数。 不要高频调用，调用频率低于1Hz。 10100000：接口执行成功；else：接口执行失败。

releasePriority()

int agvc_interface::AgvcInterface::releasePriority

(

)

释放控制权。 10100000：释放控制权成功；else：释放控制权失败。

resetAgvControllerParametersFile()

int agvc_interface::AgvcInterface::resetAgvControllerParametersFile

(

)

注意

控制权限制。 将AGV控制器的参数文件恢复出厂设置。 不要高频调用，调用频率低于1Hz。 10100000：接口执行成功；else：接口执行失败。

restartAgv()

int agvc_interface::AgvcInterface::restartAgv

(

)

重启AGV。 10100000：重启指令执行成功；else：重启指令执行失败。

scriptPaused()

int agvc_interface::AgvcInterface::scriptPaused

(

)

暂停脚本。 10100000：脚本暂停成功；else：脚本暂停失败。

scriptResume()

int agvc_interface::AgvcInterface::scriptResume

(

)

恢复脚本。 10100000：脚本恢复成功；else：脚本恢复失败。

scriptStop()

int agvc_interface::AgvcInterface::scriptStop

(

)

停止脚本。 10100000：脚本停止成功；else：脚本停止失败。

setAgvControllerParametersFile()

int agvc_interface::AgvcInterface::setAgvControllerParametersFile

(

const std::string &

agv_parameters

)

注意

控制权限制。 设置AGV控制器的参数文件。 不要高频调用，调用频率低于1Hz；此接口会默认执行刷新参数功能。 AGV控制器的参数信息。 10100000：设置参数成功；else：设置参数失败。

setAgvName()

int agvc_interface::AgvcInterface::setAgvName

(

const std::string &

agv_name

)

设置AGV的名称。 设置的AGV名称。 10100000：设置名称成功；else：设置名称失败。

setPriority()

int agvc_interface::AgvcInterface::setPriority	(	const std::string &	name,
		const std::string &	ip = "" )

设置控制权。 1.

该接口设置成功后才能正常使用控制权相关接口；2.控制权设置前需要先释放他人的控制权：releasePriority；3.Web端抢占优先权：name="web"。 登录RPC注册时的用户名。 IP地址。 10100000：设置控制权成功；else：设置控制权失败。

setScriptStatus()

int agvc_interface::AgvcInterface::setScriptStatus

(

ScriptRuntimeState

status

)

设置脚本运行状态。 10100000：设置脚本运行状态成功；else：设置脚本运行状态失败。

setSystemClock()

int agvc_interface::AgvcInterface::setSystemClock

(

const std::string &

stamp

)

设置AGV系统时间。 时间戳，格式为YYYY-MM-DDTHH:mm:ss.ssZ，例如“2017-04-15T11:40:03.12Z”。

startCalibration()

int agvc_interface::AgvcInterface::startCalibration	(	const CalibrationType &	type,
		const Header &	command_header = { "99999", "99999", 1, "99999" } )

开始标定。 标定类型。 id字段代表下发本次命令的id；其他字段无特殊含义。 10100000：接口调用成功；10120202：无控制权；else：接口调用失败。

startCollectCalibrationData()

int agvc_interface::AgvcInterface::startCollectCalibrationData	(	const CalibrationType &	type,
		const Header &	command_header = { "99999", "99999", 1, "99999" } )

开始采集数据。 LASER_ODOM标定采集数据量要求大于1000组，具体数据量可以在配置文件中修改。 标定类型。 id字段代表下发本次命令的id；其他字段无特殊含义。 10100000：接口调用成功；10120202：无控制权；else：接口调用失败。

switchSoftwareVersion()

int agvc_interface::AgvcInterface::switchSoftwareVersion

(

const std::string &

software_version

)

切换AGV软件版本。 软件版本，例如"0.3.2+3b807d1-Linux_x86_64"。 10100000：软件版本切换成功；else：软件版本切换失败。

uninstallSoftware()

int agvc_interface::AgvcInterface::uninstallSoftware

(

const std::string &

software_version

)

卸载AGV软件版本。 软件版本，例如"0.3.2+3b807d1-Linux_x86_64"。 10100000：软件版本卸载成功；else：软件版本卸载失败。

updateFirmware()

int agvc_interface::AgvcInterface::updateFirmware

(

const FirmwareUpdateParam &

update_firmware

)

AGV固件更新。 配置要更新固件的模块、固件存储路径。 10100000：下发固件更新信息成功；else：固件正在更新中。

updateSoftware()

int agvc_interface::AgvcInterface::updateSoftware

(

const std::string &

upgrade_pack_path

)

AGV软件升级。 升级包路径，例如"/root/agvc_release-0.1.1+398d1f7-Linux_x86_64.tar.gz"。 10100000：目标版本升级成功；10100201：正在升级中；else：升级失败。