通用接口

mini.mini_sdk.set_log_level(level: int, save_file: str | None = None)

设置sdk日志级别

参数:

• level – logging.DEBUG, logging.INFO, logging.WARNING, logging.ERROR

• save_file – 需要保存到文件的, 填写日志文件路径

class mini.mini_sdk.RobotType(value)

基类：Enum

机器人产品类型

DEDU = 1

悟空国内教育版

MINI = 2

悟空标准版

EDU = 3

悟空海外教育版

KOR = 4

悟空韩国版

mini.mini_sdk.set_robot_type(robot: RobotType)

设置要链接的机器人产品类型

参数:

robot – 取值为: RobotType.DEDU , RobotType.MINI, RobotType.EDU, RobotType.KOR

async mini.mini_sdk.get_device_by_name(name: str, timeout: int) → WiFiDevice | None

获取当前局域网内，指定名字的机器人设备信息

参数:

• name – 设备序列号

• timeout – 扫描超时时间

返回:

Optional[WiFiDevice]

async mini.mini_sdk.get_device_list(timeout: int) → tuple

获取当前局域网内所有机器人设备信息

参数:

timeout – 超时时间

返回:

Optional[WiFiDevice]

async mini.mini_sdk.connect(device: WiFiDevice) → bool

连接机器人设备

参数:

device (WiFiDevice) – 指定机器人设备对象

返回:

是否连接设备成功

返回类型:

bool

async mini.mini_sdk.release()

断开链接，释放资源

async mini.mini_sdk.enter_program() → bool

进入编程模式api

机器人进入编程模式

返回:

bool

async mini.mini_sdk.quit_program() → bool

退出编程模式api

机器人退出编程模式

返回:

bool

async mini.mini_sdk.play_action(action_name: str | None = None) → bool

执行内置动作api

机器人执行一个指定名称的内置动作

动作名称可用get_action_list获取

参数:

action_name (str) – 动作名称

返回:

bool

async mini.mini_sdk.stop_action() → bool

停止动作

如果动作是一个不可打断的动作, stop_action返回False

返回:

bool

async mini.mini_sdk.play_custom_action(action_name: str | None = None) → bool

执行自定义动作api

让机器人执行一个指定名称的自定义动作, 并等待结果

动作名称可用get_custom_action_list获取

参数:

action_name (str) – 自定义动作名称

返回:

bool

async mini.mini_sdk.stop_custom_action() → bool

停止自定义动作

如果动作是一个不可打断的动作, stop_action返回False

返回:

bool

async mini.mini_sdk.move(direction: MoveRobotDirection = MoveRobotDirection.FORWARD, step: int = 1) → bool

控制机器人移动

控制机器人往左(LEFTWARD)移动10步，并等待执行结果

参数:

• direction (MoveRobotDirection) – 方向

• step (int) – 步数

返回:

bool

async mini.mini_sdk.get_action_list() → list

获取取动作列表

获取机器人系统内置的动作列表，等待回复结果

返回:

动作列表

返回类型:

[]

async mini.mini_sdk.get_custom_action_list() → list

获取自定义动作列表

获取机器人/sdcard/customize/actions下的动作列表，等待回复结果

返回:

自定义动作列表

返回类型:

[]

async mini.mini_sdk.wiki(query: str) → bool

查询百科demo

查询百科，例如：查询内容”优必选”，并等待结果，机器人播报查询结果

参数:

query (str) – 查询关键字

返回:

bool

async mini.mini_sdk.translate(query: str, from_lan: LanType | None = None, to_lan: LanType | None = None, platform: ServicePlatform = ServicePlatform.BAIDU) → bool

翻译

例如:使用百度翻译，把”张学友”，从中文翻译成英文，并等待结果，机器人播报翻译结果:

translate(query=”张学友”,from_lan=CN,to_lan=EN,platform=BAIDU )

参数:

• query (str) – 关键字

• from_lan (LanType) – 源语言

• to_lan (LanType) – 目标语言

• platform (ServicePlatform) – BAIDU, GOOGLE, TENCENT

返回:

bool

async mini.mini_sdk.play_expression(express_name: str) → bool

播放表情

让机器人播放一个express_name的内置表情，并等待回复结果

参数:

express_name (str) – 表情文件名,如:”codemao1”

返回:

bool

async mini.mini_sdk.play_behavior(behavior_name: str) → bool

播放舞蹈

让机器人开始跳一个名为behavior_name的舞蹈，并等待回复结果

参数:

behavior_name (str) – 例如”dance_0004”

返回:

bool

async mini.mini_sdk.stop_behavior() → bool

停止正在播放的舞蹈

返回:

bool

async mini.mini_sdk.set_MouthLamp_NormalMode(color: MouthLampColor = MouthLampColor.RED, duration: int = 1000) → bool

设置嘴巴灯常亮模式，并等待结果

参数:

• color (MouthLampColor) – 嘴巴灯颜色，默认RED

• duration (int) – 单位ms，持续时间

返回:

bool

async mini.mini_sdk.set_MouthLamp_BreathMode(breath_duration: int = 1000, color: MouthLampColor = MouthLampColor.RED, duration: int = 1000) → bool

设置嘴巴灯呼吸模式，并等待结果

参数:

• breath_duration (int) – 单位ms，呼吸一次的时长

• color (MouthLampColor) – 嘴巴灯颜色，默认RED

• duration (int) – 单位ms，持续时间

返回:

bool

async mini.mini_sdk.switch_MouthLamp(is_open: bool = True) → bool

开关嘴巴灯

开关机器人嘴巴灯，并等待结果

参数:

is_open – bool

返回:

bool

async mini.mini_sdk.play_tts(text: str) → bool

播放tts

使机器人开始播放一段tts，并等待结果

参数:

text – str, 例如:”你好， 我是悟空， 啦啦啦”，

返回:

bool

async mini.mini_sdk.stop_tts() → bool

停止语音合成播报, 并等待结果

返回:

bool

async mini.mini_sdk.play_online_audio(url: str) → bool

播放在线音效

使机器人播放一段在线音效，

并等待结果

参数:

url – str, 例如:http://yun.lnpan.com/music/download/ring/000/075/5653bae83917a892589b372782175dd8.amr 支持格式有mp3,amr,wav 等

返回:

bool

async mini.mini_sdk.play_local_audio(local_file: str) → bool

播放本地音效

使机器人播放一段本地内置音效，音效名称为”read_016”，并等待结果

参数:

local_file –

返回:

bool

async mini.mini_sdk.stop_audio() → bool

停止所有正在播放的音频

停止所有所有音效，并等待结果

返回:

bool

async mini.mini_sdk.get_system_audio_list() → GetAudioListResponse

获取音效列表

获取机器人内置的音效列表，并等待结果

#GetAudioListResponse.audio ([Audio]) : 音效列表

#Audio.name : 音效名

#Audio.suffix : 音效后缀

#GetAudioListResponse.isSuccess : 是否成功

#GetAudioListResponse.resultCode : 返回码

返回:

GetAudioListResponse

async mini.mini_sdk.get_custom_audio_list() → GetAudioListResponse

获取音效列表

获取机器人开发者放置在/sdcard/customize/music/下的音效列表，并等待结果

#GetAudioListResponse.audio ([Audio]) : 音效列表

#Audio.name : 音效名

#Audio.suffix : 音效后缀

#GetAudioListResponse.isSuccess : 是否成功

#GetAudioListResponse.resultCode : 返回码

返回:

GetAudioListResponse

async mini.mini_sdk.change_volume(volume: float = 0.5) → bool

调整机器人音量demo

设置机器人音量为0~1，等待回复结果

参数:

volume – float 默认0.5

返回:

bool

async mini.mini_sdk.face_detect() → FaceDetectResponse

人脸个数侦测

做一次人脸个数侦测，并等待回复结果

#FaceDetectResponse.count : 人脸个数

#FaceDetectResponse.isSuccess : 是否成功

#FaceDetectResponse.resultCode : 返回码

返回:

FaceDetectResponse

async mini.mini_sdk.face_analysis() → FaceAnalyzeResponse

人脸分析（性别）

做一次人脸信息(性别、年龄)侦测，并等待回复结果

当多人存在摄像头前时，返回占画面比例最大的那个人脸信息

返回值：示例 {“age”: 24, “gender”: 99, “height”: 238, “width”: 238}

age: 年龄

gender：[1, 100], 小于50为女性，大于50为男性

height：人脸在摄像头画面中的高度

width：人脸在摄像头画面中的宽度

#FaceAnalyzeResponse.faceInfos : 人脸信息数组[FaceInfoResponse]

#FaceInfoResponse.gender (int) :[1,100],小于50为女性，大于50为男性

#FaceInfoResponse.age : 年龄

#FaceInfoResponse.width : 人脸在摄像头画面中的宽度

#FaceInfoResponse.height : 人脸在摄像头画面中的高度

#FaceAnalyzeResponse.isSuccess : 是否成功

#FaceAnalyzeResponse.resultCode : 返回码

返回:

FaceAnalyzeResponse

async mini.mini_sdk.face_recognise() → FaceRecogniseResponse

人脸识别

做一次人脸识别检测，并等待结果

#FaceRecogniseResponse.faceInfos : [FaceInfoResponse] 人脸信息数组

#FaceInfoResponse.id : 人脸id

#FaceInfoResponse.name : 姓名，如果是陌生人，则默认name为”stranger”

#FaceInfoResponse.gender : 性别

#FaceInfoResponse.age : 年龄

#FaceRecogniseResponse.isSuccess : 是否成功

#FaceRecogniseResponse.resultCode : 返回码

返回:

RecogniseObjectResponse

async mini.mini_sdk.flower_recognise() → RecogniseObjectResponse

花草识别

让机器人做一次花草识别, (需手动把花或花的照片放到机器人面前)，并等待结果

#RecogniseObjectResponse.objects : 识别结果数组[str]

#RecogniseObjectResponse.isSuccess : 是否成功

#RecogniseObjectResponse.resultCode : 返回码

返回:

RecogniseObjectResponse

async mini.mini_sdk.fruit_recognise() → RecogniseObjectResponse

水果识别

让机器人做一次水果识别, (需手动把水果或水果的照片放到机器人面前)，并等待结果

#RecogniseObjectResponse.objects : 识别结果数组[str]

#RecogniseObjectResponse.isSuccess : 是否成功

#RecogniseObjectResponse.resultCode : 返回码

返回:

RecogniseObjectResponse

async mini.mini_sdk.gesture_recognise() → RecogniseObjectResponse

手势识别

让机器人做一次用户手势识别, (需在机器人面前作出手势)，并等待结果

#RecogniseObjectResponse.objects : 识别结果数组[str]

#RecogniseObjectResponse.isSuccess : 是否成功

#RecogniseObjectResponse.resultCode : 返回码

返回:

RecogniseObjectResponse

async mini.mini_sdk.take_picture_immediately() → TakePictureResponse

拍照

让机器人立即拍照，并等待结果

#TakePictureResponse.isSuccess : 是否成功

#TakePictureResponse.code : 返回码

#TakePictureResponse.picPath : 照片在机器人里的存储路径

返回:

TakePictureResponse

async mini.mini_sdk.take_picture() → TakePictureResponse

拍照

让机器人查找人脸后再拍照，并等待结果

#TakePictureResponse.isSuccess : 是否成功

#TakePictureResponse.code : 返回码

#TakePictureResponse.picPath : 照片在机器人里的存储路径

返回:

TakePictureResponse

async mini.mini_sdk.get_register_faces() → GetRegisterFacesResponse

获取已注册的人脸信息

获取在机器人中已注册的所有人脸信息，并等待结果

#GetRegisterFacesResponse.faceInfos : [FaceInfoResponse] 人脸信息数组

#FaceInfoResponse.id : 人脸id

#FaceInfoResponse.name : 姓名

#FaceInfoResponse.gender : 性别

#FaceInfoResponse.age : 年龄

#GetRegisterFacesResponse.isSuccess : 是否成功

#GetRegisterFacesResponse.resultCode : 返回码

返回:

GetRegisterFacesResponse

async mini.mini_sdk.get_infrared_distance() → GetInfraredDistanceResponse

红外距离检测

获取当前机器人检测到的红外距离，并等待结果

#GetInfraredDistanceResponse.distance : 红外距离

返回:

GetInfraredDistanceResponse

async mini.mini_sdk.speech_recognise(timeout: int) → SpeechRecogniseResponse

语音识别api

机器人在指定时间内，执行语音识别

参数:

timeout (int) – 超时时间

返回:

bool