Skip to content

Commit ad7b3b7

Browse files
committed
更新README.md
1 parent 0aec349 commit ad7b3b7

2 files changed

Lines changed: 74 additions & 10 deletions

File tree

README.md

Lines changed: 74 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
DuerOS Python 版本客户端(app+sdk),使用百度的DCS服务
1+
# DuerOS-Python-Client使用说明
22
## 运行依赖
33
* gstreamer1.0
44
* gstreamer1.0-plugins-good
@@ -7,16 +7,80 @@ DuerOS Python 版本客户端(app+sdk),使用百度的DCS服务
77
* python-gst
88
* gir1.2-gstreamer-1.0
99
## 测试环境
10-
1110
* Ubuntu 16.04
1211
* Python 2.7.12
12+
## 使用说明
13+
### 项目获取
14+
通过git下载代码到本地
15+
16+
# git clone https://github.com/MyDuerOS/DuerOS-Python-Client.git
17+
18+
### 认证授权
19+
在DuerOS-Python-Client目录下执行
20+
21+
# ./auth.sh
22+
23+
### 通过[Enter]键触发唤醒状态
24+
在DuerOS-Python-Client目录下执行
25+
26+
# ./enter_trigger_start.sh
27+
28+
然后,每次单击[Enter]键后进行语音输入
29+
### 通过[小度小度]触发唤醒状态
30+
在DuerOS-Python-Client目录下执行
31+
32+
# ./wakeup_trigger_start.sh
33+
然后,每次通过[小度小度]进行唤醒,然后,进行语音输入
34+
35+
36+
## 代码结构
37+
DuerOS-Python-Client代码结构如下图所示,
38+
![代码结构](./readme_resources/代码结构.png)
39+
40+
其中,
41+
42+
*DuerOS-Python-Client:项目根目录*
43+
44+
* DuerOS-Python-Client/auth.sh:认证授权脚本
45+
* DuerOS-Python-Client/enter_trigger_start.sh:[Enter]按键触发唤醒脚本
46+
* DuerOS-Python-Client/wakeup_tirgger_start.sh:[小度小度]触发唤醒脚本
47+
48+
*DuerOS-Python-Client/app:应用目录*
49+
50+
* DuerOS-Python-Client/app/auth.py:认证授权实现模块
51+
* DuerOS-Python-Client/app/enter_trigger_main.py:[Enter]按键触发唤醒实现模块
52+
* DuerOS-Python-Client/app/wakeup_tirgger_main.py:[小度小度]触发唤醒实现模块
53+
* DuerOS-Python-Client/app/framework:平台相关目录
54+
* DuerOS-Python-Client/app/framework/mic.py:录音模块(基于pyaudio)
55+
* DuerOS-Python-Client/app/framework/player.py:播放模块(基于GStreamer)
56+
* DuerOS-Python-Client/app/snowboy:snowboy唤醒引擎
57+
58+
*DuerOS-Python-Client/sdk:dueros sdk目录*
59+
60+
* DuerOS-Python-Client/sdk/auth.py:授权相关实现
61+
* DuerOS-Python-Client/sdk/dueros_core.py:dueros交互实现
62+
* DuerOS-Python-Client/sdk/interface:端能力接口实现
63+
64+
## SDK接口说明
65+
### 授权模块(sdk/auth)
66+
#### 授权接口
67+
用户通过授权接口完成基于OAuth2.0的认证授权流程
68+
69+
def auth_request(client_id=CLIENT_ID, client_secret=CLIENT_SECRET):
70+
'''
71+
发起认证
72+
:param client_id:开发者注册信息
73+
:param client_secret: 开发者注册信息
74+
:return:
75+
'''
1376

14-
## 认证授权
15-
# ./auth.sh
16-
## 按键[Enter]触发运行
17-
# ./enter_trigger_start.sh
18-
## 唤醒词[小度小度]触发运行
19-
# ./wakeup_trigger_start.sh
77+
### DuerOS核心模块(sdk/dueros_core)
78+
#### directive监听注册
79+
通过监听注册接口,用户可以获得云端下发的directive内容
2080

21-
## 唤醒模型更新
22-
更换app/snowboy/xiaoduxiaodu.pmdl文件(当前的唤醒模型因为训练样板较少,唤醒率较低)
81+
def set_directive_listener(self, listener):
82+
'''
83+
directive监听器设置
84+
:param listener: directive监听器
85+
:return:
86+
'''

readme_resources/代码结构.png

95.7 KB
Loading

0 commit comments

Comments
 (0)