yunFan

来自于：官方立即使用

基本功能

startHeart stopHeart requestStatusAlways setMaxSpeed getParams shutDown netListenerStart netListenerStop getNetStatus bottomTabSet getProductId addEventListener getCheckresult humanDetect setMaxLight getPowerStatus

人脸识别

faceDetectStart faceDetectStop addFace removeFace

语音功能

setBeam wakeupBeam speak changeScene requestScene setSleepTime getSleepTime changeVoicer setServiceToastShow sendStopAudio asrLengthFilter setInteractMode pauseSpeak resumeSpeak textWrite sleep startSpeakListen stopSpeakListen

机器人动控制

leadWay turnRound startStroll stopStroll backPower moveByXY moveByName cancleMove moveByNames getRobotStatus robotControl eStop roundAngle

地图点位控制

positionAdJust getMapInfo addMarker getMarkers getMarkersCount getNormalMarkers getPowerMarker getMapMarkers getAllMap setMapAndFloor setSpeedListener removeSpeedListener addMarkerByXY positionAdJustByXY deleteMarker

概述

yunFan 云帆SDK封装，对机器人控制接口。 **

startHeart

开启心跳

startHeart({params}, callback(ret, err))

params

heartListen：

  • 类型：布尔类型
  • 描述：（可选）是否对心跳进行监听，true则返回心跳状态，false则仅开启心跳
  • 默认值：true

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     status: true,           //布尔型；是否成功
  4.     data:{
  5.         position:{          //JSON对象 ；机器人坐标
  6.                  x:，            //小数类型；
  7.                 y:，            //小数类型；
  8.         }，
  9.         powerPercent:,         //数字类型；机器人电量
  10.         outernet:'',            //外网状态；取值：网络链接失败/不稳定/正常
  11.         intranet:'',             //内网状态；取值：网络链接失败/不稳定/正常
  12.         hardwareStop:,           //布尔类型；急停按钮装填
  13.         softwareStop:,            //布尔类型；软急停状态
  14.         status:'',                 //字符串类型；任务状态 取值：running/idle/failed/succeeded/cancled
  15.         chargeState:0，            //数字类型；充电状态 取值：0/不再充电  1/正在充电
  16.         ongle:，                    //小数类型；机器人当前角度  
  17.         currentFloor: ,           //数字类型；当前楼层
  18.         interNet:,                 //小数类型；主板内网ping值
  19.         outNet: ,                   //小数类型；主板外网ping值
  20.         aiuiInterNet:,             //小数类型；核心板内网ping值
  21.         aiuiOutNet: ,               //小数类型；核心板外网ping值
  23.     }
  25. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     msg: ‘’,           //字符串类型；错误信息
  5. }

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.startHeart({
  4. }, function(ret, err) {
  5.     if (ret) {
  6.         alert(JSON.stringify(ret));
  7.     } else {
  8.         alert(JSON.stringify(err));
  9.     }
  10. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

stopHeart

关闭心跳

stopHeart({params}, callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     status: true,           //布尔型；是否成功
  5. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     msg: ‘’,           //字符串类型；错误信息
  5. }

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.stopHeart({
  4. }, function(ret, err) {
  5.     if (ret) {
  6.         alert(JSON.stringify(ret));
  7.     } else {
  8.         alert(JSON.stringify(err));
  9.     }
  10. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

faceDetectStart

人脸识别，并判断人脸是否在屏幕中间，如果不在屏幕中间则机器人转身将屏幕 正对着人脸。（1.0.1版本无效）

faceDetectStart({params}, callback(ret, err))

params

responseTime：

  • 类型：数字类型
  • 描述：（可选）人脸识别结果返回频率，单位:秒（s）
  • 默认值：5

rect:

  • 类型：JSON对象
  • 描述：（可选）摄像头显示框设置，不设置则不显示摄像头图像

  • 内部字段：

    1. {
    2. x: 50,          //（可选）数字类型；显示控件左上角x坐标；默认值：0
    3. y:50,           //（可选）数字类型；显示控件左上角y坐标；默认是：0
    4. w:200,        //（可选）数字类型;   显示控件宽度；默认值：200
    5. h:200,          //（可选）数字类型；显示控件高度；默认值：200
    6. fixedOn: ,      //(可选) 字符串类型；模块视图添加到指定 frame 的名字
    7.                      （只指 frame，传 window 无效）默认：模块依附于当前 window
    8. fixed,  //(可选项)布尔类型；模块是否随所属 window 或 frame 滚动    默认值：
    9.                 true（不随之滚动）
    10. }

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     status: true,           //布尔型；是否成功
  4.     action:'',                 //字符串类型；人脸识别事件回调  取值：‘faceCenter’/检查到
  5.     人脸并且在屏幕中央，‘faceFara’/识别到人脸但不再屏幕中央，‘faceNo’/未发现
  6.     人脸
  7.     face{                        //JSON对象；发现人脸属性；当action为faceCenter时会返回
  8.     gentder:'',                //字符串类型；性别；取值：‘Male’,'Female','exception'(未识
  9.     别出性别)
  10.     age:1,                      //数字类型；年龄
  11.     name:'',                    //字符串类型；姓名 录入人脸相似度最大的姓名
  12.     confidence:'',          //小数类型；相似度  取值：0.00--1.00
  13.     image:'',                   //base64字符串；人脸识别拍摄的图片 YUV类型数据
  14.     }
  16. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     msg: ‘’,           //字符串类型；错误信息
  5. }

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.faceDetectStart({
  4. }, function(ret, err) {
  5.     if (ret) {
  6.         alert(JSON.stringify(ret));
  7.     } else {
  8.         alert(JSON.stringify(err));
  9.     }
  10. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

faceDetectStop

停止人脸扫描（1.0.1版本无效）

faceDetectStop({params}, callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     status: true,           //布尔型；是否成功
  5. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     msg: ‘’,           //字符串类型；错误信息
  5. }

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.faceDetectStop({
  4. }, function(ret, err) {
  5.     if (ret) {
  6.         alert(JSON.stringify(ret));
  7.     } else {
  8.         alert(JSON.stringify(err));
  9.     }
  10. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

addFace

添加face到库（1.0.1版本无效）

addFace({params}, callback(ret, err))

params

data：

  • 类型：Base64字符串
  • 描述：人脸YUV图片内容

name：

  • 类型：字符串类型
  • 描述：人脸姓名

width：

  • 类型：数字类型
  • 描述：图片宽

height：

  • 类型：数字类型
  • 描述：图片高

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     status: true,           //布尔型；是否成功
  5. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     msg: ‘’,           //字符串类型；错误信息
  5. }

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.addFace({
  3.     data:'',
  4.     name:'',
  5.     width:50,
  6.     height:50
  7. }, function(ret, err) {
  8.     if (ret) {
  9.         alert(JSON.stringify(ret));
  10.     } else {
  11.         alert(JSON.stringify(err));
  12.     }
  13. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

removeFace

把人脸从库中移除（1.0.1版本无效）

removeFace({params}, callback(ret, err))

params

name：

  • 类型：字符串类型
  • 描述：人脸姓名

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     status: true,           //布尔型；是否成功
  5. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     msg: ‘’,           //字符串类型；错误信息
  5. }

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.removeFace({
  3.     name:''
  4. }, function(ret, err) {
  5.     if (ret) {
  6.         alert(JSON.stringify(ret));
  7.     } else {
  8.         alert(JSON.stringify(err));
  9.     }
  10. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setBeam

激活麦克风（注意这里只是激活，不是唤醒）

setBeam({params})

params

beam：

  • 类型：数字类型
  • 描述：麦克编号
  • 取值范围：[0, 5]

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.setBeam({
  3.     beam:1
  4. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

wakeupBeam

唤醒麦克风（改方法的效果与唤醒词唤醒机器人的的效果一样）

wakeupBeam({params})

params

beam：

  • 类型：数字类型
  • 描述：麦克编号
  • 取值范围：[0, 5]

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.wakeupBeam({
  3.     beam:1
  4. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

addEventListener

机器人事件监听

addEventListener(callback(ret))

callback(ret, err)

ret：

  • 类型：JSON 对象

  • 内部字段：

    1. {
    2.   type:'sleepTime',  //字符串；事件类型；
    3.   content:'100000',  //字符串；事件附带内容
    4.   intent:''          //字符串；事件意图
    5. }

type取值范围： wakeUp 唤醒 sleep 休眠 iat 识别结果回调 speak 讲话 speakBegin 讲话开始 speakCompleted 讲话结束 setSleep 设置休眠时间 sleepTime 获取休眠时间 setWakeUp 设置唤醒状态 leadTo 引领 musicX 唱歌识别结果 news 新闻识别 weather 天气情况识别 joke 笑话 story 故事 autoCharge 自动充电 getScene 交互情景获取 productId 获取到产品id 产品id为content内容 POWER_OFF 关机 CHARGE_STATUS_ON 未充电转充电 CHARGE_STATUS_OFF 充电转未充电 … …

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.addEventListener(function(ret){
  3.     alert(JSON.stringify(ret));
  4. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

speak

讲话

speak({params})

params

text：

  • 类型：字符串
  • 描述：要说的话

content:

  • 类型：字符串
  • 描述：text标签，用于区别speak回调中“开始说话” 和“结束说话”事件中所说的文字

rnd：

  • 类型：字符串
  • 描述：指定text中数字的读法；（比如 rnd=txt 123读“一二三”，rnd=num时，读“一百二十三”）
  • 取值范围：
    • txt
    • num

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.speak({
  3.     text:'主人，你好'
  4. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

changeScene

语音交互场景切换

changeScene({params})

params

scene：

  • 类型：字符串
  • 描述：场景
  • 取值范围：
    • asr （空场景，当机器处于ASR场景，只有唤醒和语音识别功能有效）
    • main （云帆主场景，包括音乐，笑话，新闻，天气等技能）
    • asr_en （与 ASR 场景功能完全相同，该场景下英文识别比 ASR 场景准确）

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.changeScene({
  3.     scene: 'asr'
  4. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

requestScene

获取当前场景（调用该方法后，需要在addEventListener中处理getScene事件，该事件下的content即为当前场景值）

requestScene()

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.requestScene();

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setSleepTime

设置休眠时间

setSleepTime({params})

params

time：

  • 类型：数字类型
  • 描述：休眠时间
  • 取值范围：[10000, 180000] (单位：ms)

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.setSleepTime({
  3.     time: 15000
  4. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

getSleepTime

设置休眠时间

getSleepTime()（调用该方法后，需要在addEventListener中处理sleepTime事件，该事件下的content即为当前休眠时间）

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.getSleepTime();

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

changeVoicer

切换发音人

changeVoicer({params})

params

voicer：

  • 类型：字符串
  • 描述：发音人
  • 取值范围：
    • mengmeng 童声 （注意：改发音属于在线合成，确保处于联网状态）
    • xiaofang 童声
    • xiaofeng 青年男声 播音腔
    • xiaohou 中年男声
    • xiaotong 青年女声
    • xiaoxue 青年女声 播音腔
    • xiaoyan 青年女声
    • xiaomei 青年女声 粤语

speed:

  • 类型：数字类型
  • 描述：讲话速度
  • 取值范围：[1, 100]

intonation：

  • 类型：数字类型
  • 描述：音调
  • 取值范围：[1, 100]

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.changeVoicer({
  3.     voicer:'mengmeng'
  4. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setServiceToastShow

控制语音识别Toast是否显示

setServiceToastShow({params})

params

isShow:

  • 类型：布尔类型
  • 描述：是否显示

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.setServiceToastShow({
  3.     isShow:true
  4. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

sendStopAudio

终止讲故事等语音播放

sendStopAudio({params})

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.sendStopAudio();

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

asrLengthFilter

过滤指定字节数的问题

asrLengthFilter({params})

Params

filteredLens

  • 类型：JSON数组
  • 描述：限制字节数数组

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.asrLengthFilter({
  3.     asrLengthFilter:[10, 20]
  4. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setInteractMode

切换语音交互模式 （重启后失效，在oneshot模式下唤醒后5秒内没有发出语音指令则会自动休眠）

setInteractMode({params})

Params

mode:

  • 类型：字符串
  • 描述：交互类型
  • 取值范围： oneshot （一次唤醒，一次交互） continuous （一次唤醒，多次交互）

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.setInteractMode({
  3.     mode:'oneshot'
  4. });

可用性

Android系统

可提供的1.0.0及更高版本

pauseSpeak

语音播放报暂停

pauseSpeak()

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.pauseSpeak();

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

resumeSpeak

语音播放报继续

resumeSpeak()

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.resumeSpeak();

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

textWrite

文本互动接口 （注意：使用该方法时确认机器处于唤醒状态，否则不会返回文本对应的语义结果）

textWrite({params})

Params

text:

  • 类型：字符串
  • 输入文本

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.textWrite({
  3.     text:'天气情况'
  4. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

leadWay

引领接口，指定目的地 自动前往

leadWay({params}, callback(ret, err))

Params

markerName:

  • 类型：字符串
  • 描述：目的地的名称

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     status: true,           //布尔型；是否成功
  4.     action:0                  //数字类型；移动中事件 取值：0/成功，-1/失败，1/重试，
  5.     2/   离开充电桩，3/急停，4/被困住，5/被搬动
  8. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     msg: ‘’,           //字符串类型；错误信息
  5. }

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.leadWay({
  3.     markerName:'前门'
  4. });

可用性

Android系统

可提供的1.0.0及更高版本

turnRound

转动

turnRound({params})

Params

round:

  • 类型：小数类型
  • 描述：旋转角度
  • 取值范围：-1.0-1.0

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.turnRound({
  3.     round:0.6
  4. });

可用性

Android系统

可提供的1.0.0及更高版本

textWrite

文本互动接口 （注意：使用该方法时确认机器处于唤醒状态，否则不会返回文本对应的语义结果）

textWrite({params})

Params

text:

  • 类型：字符串
  • 输入文本

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.textWrite({
  3.     text:'天气情况'
  4. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

startStroll

开始巡游

startStroll( callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     status: true,           //布尔型；是否成功
  4.      action:0                  //数字类型；移动中事件 取值：0/成功，-1/失败，1/重试，
  5.     2/   离开充电桩，3/急停，4/被困住，5/被搬动，6/电量低于伐值 自动回冲
  6.     7/电量高于限值 充电完成
  9. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     msg: ‘’,           //字符串类型；错误信息
  5. }

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.startStroll({
  3. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

stopStroll

开始巡游

stopStroll(callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     status: true,           //布尔型；是否成功
  5. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     msg: ‘’,           //字符串类型；错误信息
  5. }

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.stopStroll({
  3. });

可用性

Android系统

可提供的1.0.0及更高版本

backPower

回充电桩

backPower( callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     status: true,           //布尔型；是否成功
  4.      action:0                  //数字类型；移动中事件 取值：0/成功，-1/失败，1/重试，
  5.     2/   离开充电桩，3/急停，4/被困住，5/被搬动
  6. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     msg: ‘’,           //字符串类型；错误信息
  4. }

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.backPower({
  3. });

可用性

Android系统

可提供的1.0.0及更高版本

moveByName

根据点位名称移动

moveByName({params}, callback(ret, err))

Params

markerName:

  • 类型：字符串类型
  • 描述：目的地名称

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     status: true,           //布尔型；是否成功
  4.      result:'01001'                //字符串类型；
  5.      result取值范围：‘01002’/移动任务完成，‘01004’/移动任务取消，‘01003’/移动
  6.      任务失败，‘01001’/移动任务开始，‘01005’/移动重试，‘01010’/开始离开充
  7.      电桩，‘01011’/成功离开充电桩，‘01012’/离开充电桩失败，‘01020’/开始自动停靠充电，‘01023’/回充失败信息：未发现有效数据，‘01024’/回充失败信息：未发现有 效数据，‘01025’/回充失败信息：未发现有效充电桩位置信息，‘01026’/回充失败信息：未捕捉到电源状态，‘01027’/回充失败信息：为捕捉到红外信号，‘01030’/开始控制闸机，‘01031’/结束控制闸机，‘01032’/控制闸机已超时，强制释放控制，‘02000’/将关机断电，‘02001’/未充电变为充电状态，‘02002’/充电变为未充电状态，‘02003’/未急停变为急停状态，‘02004’/急停变为未急停状态，‘01006’/地图偏移或机器被困，‘02005’/机器被搬动，‘01101’/巡游开始，‘01102’/巡游任务完成，‘01103’/巡游任务失败，当最后一个移动任务失败时发送此通知，‘01104’/巡游任务被取消
  8. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     msg: ‘’,           //字符串类型；错误信息
  4. }

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.moveByName({
  3.   markerName:'大门',
  4. });

可用性

Android系统

可提供的1.0.0及更高版本

moveByXY

根据xy坐标移动

moveByName({params}, callback(ret, err))

Params

x:

  • 类型：小数类型
  • 描述：（可选项）目的地的x坐标
  • 默认值：0

y:

  • 类型：小数类型
  • 描述：（可选项）目的地的y坐标
  • 默认值：0

round:

  • 类型：小数类型
  • 描述：（可选项）角度
  • 取值范围：-1-1
  • 默认值：0

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     status: true,           //布尔型；是否成功
  4.      result:'01001'                //字符串类型；
  5.      result取值范围：‘01002’/移动任务完成，‘01004’/移动任务取消，‘01003’/移动
  6.      任务失败，‘01001’/移动任务开始，‘01005’/移动重试，‘01010’/开始离开充
  7.      电桩，‘01011’/成功离开充电桩，‘01012’/离开充电桩失败，‘01020’/开始自动停靠充电，‘01023’/回充失败信息：未发现有效数据，‘01024’/回充失败信息：未发现有 效数据，‘01025’/回充失败信息：未发现有效充电桩位置信息，‘01026’/回充失败信息：未捕捉到电源状态，‘01027’/回充失败信息：为捕捉到红外信号，‘01030’/开始控制闸机，‘01031’/结束控制闸机，‘01032’/控制闸机已超时，强制释放控制，‘02000’/将关机断电，‘02001’/未充电变为充电状态，‘02002’/充电变为未充电状态，‘02003’/未急停变为急停状态，‘02004’/急停变为未急停状态，‘01006’/地图偏移或机器被困，‘02005’/机器被搬动，‘01101’/巡游开始，‘01102’/巡游任务完成，‘01103’/巡游任务失败，当最后一个移动任务失败时发送此通知，‘01104’/巡游任务被取消
  8. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     msg: ‘’,           //字符串类型；错误信息
  4. }

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.moveByXY({
  3.   x:10,
  4.   y:11,
  5.   round:0.5,
  6. });

可用性

Android系统

可提供的1.0.0及更高版本

cancleMove

放弃当前移动任务，进入待命状态

cancleMove(callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     status: true,           //布尔型；是否成功
  4.      result:'01001'                //字符串类型；
  5.      result取值范围：‘01002’/移动任务完成，‘01004’/移动任务取消，‘01003’/移动
  6.      任务失败，‘01001’/移动任务开始，‘01005’/移动重试，‘01010’/开始离开充
  7.      电桩，‘01011’/成功离开充电桩，‘01012’/离开充电桩失败，‘01020’/开始自动停靠充电，‘01023’/回充失败信息：未发现有效数据，‘01024’/回充失败信息：未发现有 效数据，‘01025’/回充失败信息：未发现有效充电桩位置信息，‘01026’/回充失败信息：未捕捉到电源状态，‘01027’/回充失败信息：为捕捉到红外信号，‘01030’/开始控制闸机，‘01031’/结束控制闸机，‘01032’/控制闸机已超时，强制释放控制，‘02000’/将关机断电，‘02001’/未充电变为充电状态，‘02002’/充电变为未充电状态，‘02003’/未急停变为急停状态，‘02004’/急停变为未急停状态，‘01006’/地图偏移或机器被困，‘02005’/机器被搬动，‘01101’/巡游开始，‘01102’/巡游任务完成，‘01103’/巡游任务失败，当最后一个移动任务失败时发送此通知，‘01104’/巡游任务被取消
  8. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     msg: ‘’,           //字符串类型；错误信息
  4. }

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.cancleMove({
  3. });

可用性

Android系统

可提供的1.0.0及更高版本

moveByNames

根据xy坐标移动

moveByNames({params}, callback(ret, err))

Params

markerNames:

  • 类型：字符串数组
  • 描述：目的地名称

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     status: true,           //布尔型；是否成功
  4.      result:'01001'                //字符串类型；
  5.      result取值范围：‘01002’/移动任务完成，‘01004’/移动任务取消，‘01003’/移动
  6.      任务失败，‘01001’/移动任务开始，‘01005’/移动重试，‘01010’/开始离开充
  7.      电桩，‘01011’/成功离开充电桩，‘01012’/离开充电桩失败，‘01020’/开始自动停靠充电，‘01023’/回充失败信息：未发现有效数据，‘01024’/回充失败信息：未发现有 效数据，‘01025’/回充失败信息：未发现有效充电桩位置信息，‘01026’/回充失败信息：未捕捉到电源状态，‘01027’/回充失败信息：为捕捉到红外信号，‘01030’/开始控制闸机，‘01031’/结束控制闸机，‘01032’/控制闸机已超时，强制释放控制，‘02000’/将关机断电，‘02001’/未充电变为充电状态，‘02002’/充电变为未充电状态，‘02003’/未急停变为急停状态，‘02004’/急停变为未急停状态，‘01006’/地图偏移或机器被困，‘02005’/机器被搬动，‘01101’/巡游开始，‘01102’/巡游任务完成，‘01103’/巡游任务失败，当最后一个移动任务失败时发送此通知，‘01104’/巡游任务被取消
  8. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     msg: ‘’,           //字符串类型；错误信息
  4. }

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.moveByNames({
  3.   markerNames:['大门','大厅'],
  4. });

可用性

Android系统

可提供的1.0.0及更高版本

getRobotStatus

获取机器人当前全局状态，包括任务状态

getRobotStatus( callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     status: true,           //布尔型；是否成功
  4.      result:              //JSON对象；当前状态 ；字段：{
  5.          move_target/字符串类型；目标点别名，
  6.          move_status/字符串类型任务状态（running、idle、failed、succeeded、canceled）,
  7.          move_retry_times/数字类型；路径重试次数，
  8.          charge_state/布尔类型；充电状态（true/充电中 false/未充电）,
  9.          soft_estop_state/布尔类型；通过api调用 机器急停状态（true/处于急停状态 false/非急停状态）
  10.          ,hard_estop_state/布尔类型；通过硬件机器急停状态，
  11.          estop_state/布尔类型；急停状态，
  12.          power_percent/数字类型；电量百分比，
  13.          current_pose/JSON对象类型；位置信息
  14.                 {
  15.                     x:/小数类型 ；单色：m
  16.                     y:/小数类型；单位：m
  17.                     theta:/小数类型；
  18.                 }，
  19.           current_floor/数字类型；楼层
  21.      }
  22. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     msg: ‘’,           //字符串类型；错误信息
  5. }

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.getRobotStatus(function(ret, err) {
  3. if (ret) {
  4. alert(JSON.stringify(ret));
  5. } else {
  6. alert(JSON.stringify(err));
  7. }
  8. });

可用性

Android系统

可提供的1.0.0及更高版本

addMarker

添加新的点位

addMarker({params}, callback(ret, err))

Params

markerName:

  • 类型：字符串类型
  • 描述：目的地名称

type

  • 类型：数字类型
  • 描述：（可选项）点位类型
  • 取值范围：0/一般点位，11/充电桩
  • 默认值：0

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     status: true,           //布尔型；是否成功
  5. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     msg: ‘’,           //字符串类型；错误信息
  4. }

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.addMarker({
  3.   markerName:‘厕所’
  4. });

可用性

Android系统

可提供的1.0.0及更高版本

getMarkers

获取点位列表

getMarkers({params}, callback(ret, err))

Params

floor:

  • 类型：数字类型
  • 描述：（可选）楼层
  • 默认：当前楼层

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     status: true,                //布尔型；是否成功
  4.     markers: ，                //JSON数组；
  5.         [{
  6.              floor: 1,              //数字类型；楼层
  7.              markerName:''   //字符串类型；点位名称
  8.         },
  9.         ]
  10. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     msg: ‘’,           //字符串类型；错误信息
  4. }

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.getMarkers(function(ret) {
  3. if (ret) {
  4. alert(JSON.stringify(ret));
  6. }
  7. });

可用性

Android系统

可提供的1.0.0及更高版本

getMarkersCount

获取点位个数

getMarkersCount( callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     status: true,                //布尔型；是否成功
  4.     count: ，                //数字类型；  点位个数
  5. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     msg: ‘’,           //字符串类型；错误信息
  4. }

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.getMarkersCount(function(ret) {
  3. if (ret) {
  4. alert(JSON.stringify(ret));
  5. }
  6. });

可用性

Android系统

可提供的1.0.0及更高版本

robotControl

直接控制机器人前进后退转动，单个指令持续0.5s，可持续发送命令使动作连贯 此过程机器人不会自主避障

robotControl({params}, callback(ret, err))

Params

angular:

  • 类型：小数类型
  • 描述：角速度
  • 取值范围：-1 - 1

linear:

  • 类型：小数类型
  • 描述：线速度
  • 取值换谁：-0.5 - 0.5

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     status: true,                //布尔型；是否成功
  4. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     angular: ,           //小数类型；
  4.     linear:,                //小数类型；
  5. }

示例代码

  1. yunFan.robotControl({
  2. angular:0.5,
  3. linear:-0.5,
  4. },function(ret) {
  5. if (ret) {
  6. alert(JSON.stringify(ret));
  7. }
  8. });

用性

Android系统

可提供的1.0.0及更高版本

eStop

机器人急停设置

eStop({params}, callback(ret, err))

Params

stop:

  • 类型：布尔类型
  • 描述：（可选项）需要切换得状态；true/进入急停状态，false/退出急停状态
  • 默认值：true

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     status: true,                //布尔型；是否成功
  4. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     stop:   //布尔类型；指令中急停状态
  4. }

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.eStop({
  3. stop:false,
  4. },function(ret, err) {
  5. if (ret) {
  6. alert(JSON.stringify(ret));
  7. } else {
  8. alert(JSON.stringify(err));
  9. }
  10. });

可用性

Android系统

可提供的1.0.0及更高版本

positionAdJust

位置矫正

positionAdJust({params}, callback(ret, err))

Params

markerName:

  • 类型：字符串类型
  • 描述：点位别名

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     status: true,                //布尔型；是否成功
  4. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     markerName:   //字符串类型；位置矫正失败 点位别名
  3. }

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.positionAdJust({
  3. markerName: '大门'
  4. },function(ret) {
  5. if (ret) {
  6. alert(JSON.stringify(ret));
  7. }
  8. });

可用性

Android系统

可提供的1.0.0及更高版本

requestStatusAlways

设置返回机器人时时数据

requestStatusAlways({params}, callback(ret, err))

Params

flag:

  • 类型：布尔类型
  • 描述：是否开启数据发送；true/开启，false/关闭
  • 默认值：true

frequency

  • 类型：数字类型
  • 描述：数据发送频率
  • 取值范围：1 - 10

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     status: true,                //布尔型；是否成功
  4.      result:              //JSON对象；当前状态 ；字段：{
  5.          move_target/字符串类型；目标点别名，
  6.          move_status/字符串类型任务状态（running、idle、failed、succeeded、canceled）,
  7.          move_retry_times/数字类型；路径重试次数，
  8.          charge_state/布尔类型；充电状态（true/充电中 false/未充电）,
  9.          soft_estop_state/布尔类型；通过api调用 机器急停状态（true/处于急停状态 false/非急停状态）
  10.          ,hard_estop_state/布尔类型；通过硬件机器急停状态，
  11.          estop_state/布尔类型；急停状态，
  12.          power_percent/数字类型；电量百分比，
  13.          current_pose/JSON对象类型；位置信息
  14.                 {
  15.                     x:/小数类型 ；单色：m
  16.                     y:/小数类型；单位：m
  17.                     theta:/小数类型；
  18.                 }，
  19.           current_floor/数字类型；楼层
  21.      }
  22. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     msg:   //字符串类型；指令调用失败
  3. }

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.requestStatusAlways({
  3. flag:true,
  4. frequency:5
  5. },function(ret) {
  6. if (ret) {
  7. alert(JSON.stringify(ret));
  8. }
  9. });

可用性

Android系统

可提供的1.0.0及更高版本

setMaxSpeed

设置返回机器人时时数据

setMaxSpeed({params}, callback(ret, err))

Params

speed:

  • 类型：小数类型
  • 描述：速度，实际意义为0.7的倍数，实际速度为（0.7*speed）m/s
  • 取值范围：0.3 - 1.4

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     status: true,                //布尔型；是否成功
  4. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     speed:   //字符串类型；指定的速度
  3. }

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.setMaxSpeed({
  3. speed:0.5,
  4. },function(ret) {
  5. if (ret) {
  6. alert(JSON.stringify(ret));
  7. }
  8. });

可用性

Android系统

可提供的1.0.0及更高版本

getParams

获取机器人参数；目前只有最大速度

getParams( callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     status: true,                //布尔型；是否成功
  4.     paramter:{                    //JSON对象；当前参数
  5.         max_speed：   //小数类型；最大速度
  6.     }
  7. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     msg:   //字符串类型；错误信息
  3. }

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.getParams({
  3. },function(ret) {
  4. if (ret) {
  5. alert(JSON.stringify(ret));
  6. }
  7. });

可用性

Android系统

可提供的1.0.0及更高版本

shutDown

关机

shutDown({params}, callback(ret, err))

Params

restart:

  • 类型：布尔类型
  • 描述：是否重启；true/关机后重启，false/关机后不重启
  • 默认值：false

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     status: true,                //布尔型；是否成功
  4. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     msg:   //字符串类型；错误信息
  3. }

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.shutDown({
  3. },function(ret, err) {
  4. if (ret) {
  5. alert(JSON.stringify(ret));
  6. } else {
  7. alert(JSON.stringify(err));
  8. }
  9. });

可用性

Android系统

可提供的1.0.0及更高版本

getMapInfo

获取当前地图名称

getMapInfo(callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     status: true,                //布尔型；是否成功
  4.     mapName:'',              //字符串类型；地图名称
  5.     floor:,                          //字符串类型；当前地图楼层
  6.     info:{                          //JSON对象类型；地图信息
  7.         height:                   //数字类型；高度
  8.         width:                   //数字类型；宽度
  9.         origin_x:              //小数类型；左下角x坐标
  10.         origin_y:               //小数类型；左下角y坐标
  11.         resolution：         //小数类型；分辨率（米/像素）
  12.     }
  13. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     msg:   //字符串类型；错误信息
  3. }

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.getMapInfo({
  3. },function(ret) {
  4. if (ret) {
  5. alert(JSON.stringify(ret));
  6. }
  7. });

可用性

Android系统

可提供的1.0.0及更高版本

getNormalMarkers

获取当前楼层除充电桩之外的所有点位

getNormalMarkers( callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     status: true,                //布尔型；是否成功
  4.     markers: ，                //JSON数组；
  5.         [{
  6.              floor: 1,              //数字类型；楼层
  7.              marker_name:'',   //字符串类型；点位名称
  8.              key: ,                   //数字类型
  9.              pose:{             //JSON对象类型
  10.                      orientation{      //JSON对象类型
  11.                           w:,        //小数类型
  12.                           x:,          //小数类型
  13.                           y:,         //小数类型
  14.                           z:,         //小数类型
  15.                     }，
  16.                     position:{        //JSON对象类型
  17.                         x: ,        //小数类型
  18.                         y:,         //小数类型
  19.                         z:,          小数类型
  20.                     }
  21.              }，
  23.         },
  24.         ]
  25. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     msg:   //字符串类型；错误信息
  3. }

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.getNormalMarkers({
  3. },function(ret) {
  4. if (ret) {
  5. alert(JSON.stringify(ret));
  6. }
  7. });

可用性

Android系统

可提供的1.0.0及更高版本

getPowerMarker

获取当前楼层充电桩点位

getPowerMarker(callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     status: true,                //布尔型；是否成功
  4.     marker: ，                //JSON对象；
  5.         {
  6.              floor: 1,              //数字类型；楼层
  7.              marker_name:'',   //字符串类型；点位名称
  8.              key: ,                   //数字类型
  9.              pose:{             //JSON对象类型
  10.                      orientation{      //JSON对象类型
  11.                           w:,        //小数类型
  12.                           x:,          //小数类型
  13.                           y:,         //小数类型
  14.                           z:,         //小数类型
  15.                     }，
  16.                     position:{        //JSON对象类型
  17.                         x: ,        //小数类型
  18.                         y:,         //小数类型
  19.                         z:,          小数类型
  20.                     }
  21.              }，
  22.              d
  23.         },
  25. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     msg:   //字符串类型；错误信息
  3. }

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.getPowerMarker({
  3. },function(ret) {
  4. if (ret) {
  5. alert(JSON.stringify(ret));
  6. }
  7. });

可用性

Android系统

可提供的1.0.0及更高版本

getMapMarkers

获取map型点位列表

getMapMarkers( callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     status: true,                //布尔型；是否成功
  4.     markers: ，                //JSON数组；
  5.         [{
  6.          type:'',                      //字符串类型；
  7.          marker:   {                 //JSON对象类型
  8.                  floor: 1,              //数字类型；楼层
  9.                  marker_name:'',   //字符串类型；点位名称
  10.                  key: ,                   //数字类型
  11.                  pose:{             //JSON对象类型
  12.                         orientation{      //JSON对象类型
  13.                               w:,        //小数类型
  14.                               x:,          //小数类型
  15.                               y:,         //小数类型
  16.                               z:,         //小数类型
  17.                         }，
  18.                         position:{        //JSON对象类型
  19.                             x: ,        //小数类型
  20.                             y:,         //小数类型
  21.                             z:,          小数类型
  22.                         }
  23.                  }，
  24.             }
  25.          }
  26.         ]
  28. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. msg:   //字符串类型；错误信息
  3. }

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.getMapMarkers({
  3. },function(ret) {
  4. if (ret) {
  5. alert(JSON.stringify(ret));
  6. }
  7. });

可用性

Android系统

可提供的1.0.0及更高版本

getMarkerByName

根据点位名称获取点位信息

getMarkerByName({params}, callback(ret, err))

Params

makerName:

  • 类型：字符串类型
  • 描述：点位名称

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     status: true,                //布尔型；是否成功
  4.     marker: ，                //JSON对象；
  5.         {
  6.              floor: 1,              //数字类型；楼层
  7.              marker_name:'',   //字符串类型；点位名称
  8.              key: ,                   //数字类型
  9.              pose:{             //JSON对象类型
  10.                      orientation{      //JSON对象类型
  11.                           w:,        //小数类型
  12.                           x:,          //小数类型
  13.                           y:,         //小数类型
  14.                           z:,         //小数类型
  15.                     }，
  16.                     position:{        //JSON对象类型
  17.                         x: ,        //小数类型
  18.                         y:,         //小数类型
  19.                         z:,          小数类型
  20.                     }
  21.              }，
  22.              d
  23.         },
  25. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     msg:   //字符串类型；错误信息
  3. }

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.getMarkerByName({
  3. makerName:'迎宾点'，
  4. },function(ret) {
  5. if (ret) {
  6. alert(JSON.stringify(ret));
  7. }
  8. });

可用性

Android系统

可提供的1.0.0及更高版本

netListenerStart

开启网络状态监听，不实时回调，配合getNetStatus接口使用

netListenerStart( callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     status: true,                //布尔型；是否成功
  5. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     msg:   //字符串类型；错误信息
  3. }

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.netListenerStart(
  3. function(ret) {
  4. if (ret) {
  5. alert(JSON.stringify(ret));
  6. }
  7. });

可用性

Android系统

可提供的1.0.0及更高版本

getNetStatus

获取当前网络状态，调用netListenerStart 接口后才可以获取实时网络状态

getNetStatus(callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     status: true,                //布尔型；是否成功
  4.     netStatus:{                   //JSON对象；网络状态
  5.         outNetPing: ,               //小数类型；外网ping值
  6.         inNetPing: ,                 //小数类型；内网ping值
  7.         mainInNetPing: ,        //小数类型；主板内网ping值
  8.         mainOutNetPing: ,    //小数类型；主板外网ping值
  9.         inNetStatus: ,               //数字类型；内网网络状态；-1:网络未连接  0:较差 
  10.         1:一般  2:良好
  11.         outNetStatus: ,         //数字类型；外网网络状态；-1:网络未连接  0:较差  
  12.         1:一般  2:良好
  13.     },
  14. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     msg:   //字符串类型；错误信息
  3. }

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.getNetStatus(
  3. function(ret) {
  4. if (ret) {
  5. alert(JSON.stringify(ret));
  6. }
  7. });

可用性

Android系统

可提供的1.0.0及更高版本

bottomTabSet

设置底部虚拟按键隐藏显示

bottomTabSet({params}, callback(ret, err))

Parameter

hide

  • 类型：布尔类型
  • 说明：（可选）是否隐藏底部虚拟按键
  • 默认值：false

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.bottomTabSet({
  3. hide:true,
  4. });

可用性

Android系统

可提供的1.0.0及更高版本

getProductId

获取产品Id，在addEventListener回调中接收productId.详情请见

addEventListener

getProductId( callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     status: true,                //布尔型；是否成功
  4.     productId:'',                //字符串类型；产品id
  5. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     msg:   //字符串类型；错误信息
  3. }

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.getProductId(
  3. function(ret) {
  4. if (ret) {
  5. alert(JSON.stringify(ret));
  6. }
  7. });

可用性

Android系统

可提供的1.0.0及更高版本

sleep

休眠

sleep(callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     status: true,                //布尔型；是否成功
  4. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     msg:   //字符串类型；错误信息
  3. }

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.sleep(
  3. function(ret) {
  4. if (ret) {
  5. alert(JSON.stringify(ret));
  6. }
  7. });

可用性

Android系统

可提供的1.0.0及更高版本

getAllMap

获取所有楼层地图

getAllMap(callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. js
  2. {
  4.     status: true,                //布尔型；是否成功
  5.     maps:[                        //JSON数组类型；地图信息
  6.     {
  7.         mapName:'',           //字符串类型；地图名称
  8.         floor:[                          //数组类型；对应楼层
  9.         1,3,5
  10.         ]                 
  11.     },
  12.     ]
  13. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. js
  2. {
  3.     msg:   //字符串类型；错误信息
  4. }

示例代码

  1. js
  2. var yunFan = api.require('yunFan');
  3. yunFan.getAllMap(
  4. function(ret) {
  5. if (ret) {
  6. alert(JSON.stringify(ret));
  7. }
  8. });

可用性

Android系统

可提供的1.0.0及更高版本

setMapAndFloor

设置当前楼层地图

setMapAndFloor({params}, callback(ret, err))

parameter

mapName

  • 类型：字符串类型
  • 说明：地图名称

floor

  • 类型：数字类型
  • 说明：楼层

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. js
  2. {
  4.     status: true,                //布尔型；是否成功
  6. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. js
  2. {
  3.     msg:   //字符串类型；错误信息
  4. }

示例代码

  1. js
  2. var yunFan = api.require('yunFan');
  3. yunFan.setMapAndFloor(
  4. function(ret) {
  5. if (ret) {
  6. alert(JSON.stringify(ret));
  7. }
  8. });

可用性

Android系统

可提供的1.0.0及更高版本

getCheckresult

获取当前地盘状态

getCheckresult( callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. js
  2. {
  3. status: true,                //布尔型；是否成功
  4. result:[                        //JSON字符串；地盘自检结果
  5. key:'',                     //字符串类型；自检项
  6.    value:{                   //JSON对象；自检结果
  7.       },
  8.     ]
  9. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. js
  2. {
  3.     msg:   //字符串类型；错误信息
  4. }

示例代码

  1. js
  2. var yunFan = api.require('yunFan');
  3. yunFan.getCheckresult(
  4. function(ret) {
  5. if (ret) {
  6. alert(JSON.stringify(ret));
  7. }
  8. });

可用性

Android系统

可提供的1.0.0及更高版本

setSpeedListener

时时监听运行速度

setSpeedListener({params}, callback(ret, err))

parameter

frequency

  • 类型：小数类型
  • 描述：（可选项）数据发送频率
  • 默认值：1

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. js
  2. {
  4.     status: true,                //布尔型；是否成功
  5.     angular: ,                     //小数类型；角速度
  6.     linear:,                         //小数类型；线速度
  7. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. js
  2. {
  3.     msg:   //字符串类型；错误信息
  4. }

示例代码

  1. js
  2. var yunFan = api.require('yunFan');
  3. yunFan.setSpeedListener(
  4. function(ret) {
  5. if (ret) {
  6. alert(JSON.stringify(ret));
  7. }
  8. });

可用性

Android系统

可提供的1.0.0及更高版本

removeSpeedListener

取消时时监听运行速度

removeSpeedListener(callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. js
  2. {
  4.     status: true,                //布尔型；是否成功
  5. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. js
  2. {
  3.     msg:   //字符串类型；错误信息
  4. }

示例代码

  1. js
  2. var yunFan = api.require('yunFan');
  3. yunFan.removeSpeedListener(
  4. function(ret) {
  5. if (ret) {
  6. alert(JSON.stringify(ret));
  7. }
  8. });

可用性

Android系统

可提供的1.0.0及更高版本

humanDetect

开启人腿时时检测

humanDetect({params}, callback(ret, err))

parameter

frequency

  • 类型：小数类型
  • 描述：（可选项）数据发送频率
  • 默认值：1

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. js
  2. {
  3. status: true,                //布尔型；是否成功
  4.    humanS:[                    //JSON数组；人腿们
  5.     {
  6.        id:'',                     //字符串类型；id
  7.           value:{                    //JSON对象类型；检测到人的位置信息
  8.             }
  10.         },
  11.     ]
  12. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. js
  2. {
  3.     msg:   //字符串类型；错误信息
  4. }

示例代码

  1. js
  2. var yunFan = api.require('yunFan');
  3. yunFan.humanDetect(
  4. function(ret) {
  5. if (ret) {
  6. alert(JSON.stringify(ret));
  7. }
  8. });

可用性

Android系统

可提供的1.0.0及更高版本

setMaxLight

设置灯带最大亮度，急停或者充电状态下此接口虽然返回成功但是设置不能生效

setMaxLight({params}, callback(ret, err))

parameter

value

  • 类型：数字类型
  • 描述：最大亮度值

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     status: true,                //布尔型；是否成功
  4. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. js
  2. {
  3. msg:   //字符串类型；错误信息
  4. }

示例代码

  1. js
  2. var yunFan = api.require('yunFan');
  3. yunFan.setMaxLight({
  4. value:5
  5. },
  6. function(ret) {
  7. if (ret) {
  8. alert(JSON.stringify(ret));
  9. }
  10. });

可用性

Android系统

可提供的1.0.0及更高版本

getPowerStatus

获取当前电池状态

getPowerStatus(callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. js
  2. {
  4.     status: true,                //布尔型；是否成功
  5.     power:{                      //JSON对象类型；电池状态信息
  6.         basecurren:,       //小数类型；基本小号类型
  7.         battery_capacit:,      //数字类型；电量百分比
  8.         battery_curren:,        //小数类型；净充电电流
  9.         battery_ voltag:,        //小数类型；电池电压
  10.         charge_voltag:,         //小数类型；充电电压
  11.         charger_connected_notice:,     //布尔类型；是否在充电
  12.         head_current:,         //小数类型；上位机消耗电流
  13.         motorcurren:,         //小数类型；电机消耗电流
  14.     },
  15. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     msg:   //字符串类型；错误信息
  3. }

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.getPowerStatus(
  3. function(ret) {
  4. if (ret) {
  5. alert(JSON.stringify(ret));
  6. }
  7. });

可用性

Android系统

可提供的1.0.0及更高版本

addMarkerByXY

根据坐标插入点位

addMarkerByXY({params}, callback(ret, err))

parameter

markerName:

  • 类型：字符串类型
  • 描述：目的地名称

x

  • 类型：小数类型
  • 描述：x轴坐标

y

  • 类型：小数类型
  • 描述：y轴坐标

theta

  • 类型：小数类型
  • 描述：点位方向；theta 与四元数转换关系 C++ 示例: 假设四元数表示的方向为: o{x: 0, y:0, z: -0.430000007152557, w:- 0.899999976158142} double theta = 2atan2(o.z, o.w) if (theta > M_PI && theta <= (2M_PI)) { theta -= 2M_PI; } else if(theta < (-1M_PI) && theta >= (-2M_PI)) { theta += 2M_PI; }
  • 取值范围：[-π - π]

type

  • 类型：数字类型
  • 描述：（可选项）点位类型
  • 取值范围：0/一般点位，11/充电桩
  • 默认值：0

floor

  • 类型：数字类型
  • 描述：（可选项）楼层
  • 默认值：当前楼层

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     status: true,                //布尔型；是否成功
  5. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     msg:   //字符串类型；错误信息
  3. }

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.addMarkerByXY({
  3. markerName:'',
  4. x:,
  5. y:,
  6. theta:3,
  7. }，
  8. function(ret) {
  9. if (ret) {
  10. alert(JSON.stringify(ret));
  11. }
  12. });

可用性

Android系统

可提供的1.0.0及更高版本

positionAdJustByXY

按坐标矫正机器人位置

positionAdJustByXY({params}, callback(ret, err))

parameter

x

  • 类型：小数类型
  • 描述：x轴坐标

y

  • 类型：小数类型
  • 描述：y轴坐标

theta

  • 类型：小数类型
  • 描述：点位方向；theta 与四元数转换关系 C++ 示例: 假设四元数表示的方向为: o{x: 0, y:0, z: -0.430000007152557, w:- 0.899999976158142} double theta = 2atan2(o.z, o.w) if (theta > M_PI && theta <= (2M_PI)) { theta -= 2M_PI; } else if(theta < (-1M_PI) && theta >= (-2M_PI)) { theta += 2M_PI; }
  • 取值范围：[-π - π]

floor

  • 类型：数字类型
  • 描述：（可选项）楼层
  • 默认值：当前楼层

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     status: true,                //布尔型；是否成功
  5. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     msg:   //字符串类型；错误信息
  3. }

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.positionAdJustByXY({
  3. x:,
  4. y:,
  5. theta:3,
  6. }，
  7. function(ret) {
  8. if (ret) {
  9. alert(JSON.stringify(ret));
  10. }
  11. });

可用性

Android系统

可提供的1.0.0及更高版本

deleteMarker

删除点位

deleteMarker({params}, callback(ret, err))

parameter

markerName:

  • 类型：字符串类型
  • 描述：目的地名称

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     status: true,                //布尔型；是否成功
  5. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     msg:   //字符串类型；错误信息
  3. }

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.deleteMarker({
  3. markerName:‘’,
  4. }，
  5. function(ret) {
  6. if (ret) {
  7. alert(JSON.stringify(ret));
  8. }
  9. });

可用性

Android系统

可提供的1.0.0及更高版本

startSpeakListen

开启播报监听

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     status: true,                //布尔型；是否成功
  4.    speakTag:'',                 //字符串类型；speak接口时传入的参数”content”的值
  5.    progres:                      //数字类型；语音播报进度（百分比）
  6. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     msg:   //字符串类型；错误信息
  3. }

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.startSpeakListen(
  3. function(ret) {
  4. if (ret) {
  5. alert(JSON.stringify(ret));
  6. }
  7. });

可用性

Android系统

可提供的1.0.0及更高版本

roundAngle

连续旋转一定角度

roundAngle({params}, callback(ret, err))

parameter

turnAngle：

  • 类型：小数类型
  • 描述：旋转的角度，左负右正

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  3.     status: true,                //布尔型；是否成功
  4. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     msg:   //字符串类型；错误信息
  3. }

示例代码

  1. var yunFan = api.require('yunFan');
  2. yunFan.roundAngle({
  3. turnAngle:,              //小数类型，旋转角度，左负右正
  4. },
  5. function(ret) {
  6. if (ret) {
  7. alert(JSON.stringify(ret));
  8. }
  9. });

可用性

Android系统

可提供的1.0.0及更高版本