Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

将"使能"(enable)全部替换为"打开" #4

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/quick_start.rst
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ RoboMaster EP 作为一款教育机器人,具有强大的扩展性和可编程
当运行窗口输出 ``Connecting...`` 时,代表正在尝试与机器人建立连接,当运行窗口输出 ``Connected!`` 时,表示已经成功建立控制连接。


使能 SDK 模式
打开 SDK 模式
------------------

要进行 SDK 控制,我们需要控制机器人进入 SDK 模式。 在上述 Python 运行窗口输入 *command* 命令,按回车键,程序将会发送该命令至机器人,返回 *ok* 即机器人成功进入 SDK 模式::
Expand Down
10 changes: 5 additions & 5 deletions docs/sdk/connection.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
========= ======== ========== =================================================
视频流 40921 TCP 需执行开启视频流推送命令,才有数据输出
音频流 40922 TCP 需执行开启音频流推送命令,才有数据输出
控制命令 40923 TCP 可通过当前通道使能 SDK 模式,参见 **SDK 模式控制**
控制命令 40923 TCP 可通过当前通道打开 SDK 模式,参见 **SDK 模式控制**
消息推送 40924 UDP 需执行开启消息推送命令,才有数据输出
事件上报 40925 TCP 需执行开启事件上报命令,才有数据输出
IP 广播 40926 UDP 当机器人未与任何设备建立连接时,会有数据输出
Expand Down Expand Up @@ -86,9 +86,9 @@ Wi-Fi 直连

3. 准备连接脚本

建立 Wi-Fi 连接后,我们还需要编程与机器人建立 TPC/IP 连接 机器人开放多个连接端口可供连接,我们首先应完成 **控制命令端口** 的连接(直连模式下机器人 IP 地址为 ``192.168.2.1``, 控制命令端口号: ``40923``),以使能机器人 SDK 模式。
建立 Wi-Fi 连接后,我们还需要编程与机器人建立 TPC/IP 连接 机器人开放多个连接端口可供连接,我们首先应完成 **控制命令端口** 的连接(直连模式下机器人 IP 地址为 ``192.168.2.1``, 控制命令端口号: ``40923``),以打开机器人 SDK 模式。

这里我们以 Python 编程语言为例,编写脚本来完成 *建立控制连接,使能 SDK 模式* 功能
这里我们以 Python 编程语言为例,编写脚本来完成 *建立控制连接,打开 SDK 模式* 功能

参考代码如下

Expand Down Expand Up @@ -196,7 +196,7 @@ Wi-Fi/有线网络组网连接

3. 获取机器人在局域网内的 IP 地址

在完成组网连接后,我们的 PC 机已经和机器人处于同一个局域网内,接下来需要编程与机器人建立 TPC/IP 连接,并连接到 **控制命令端口** 端口,以使能机器人 SDK 模式。
在完成组网连接后,我们的 PC 机已经和机器人处于同一个局域网内,接下来需要编程与机器人建立 TPC/IP 连接,并连接到 **控制命令端口** 端口,以打开机器人 SDK 模式。

若您使用的路由器开启了 DHCP 服务,则机器人的 IP 地址为路由器动态分配,我们需要进一步获取机器人在局域网内的 IP 地址。这里提供两种办法获取:

Expand Down Expand Up @@ -230,7 +230,7 @@ Wi-Fi/有线网络组网连接

3. 准备连接脚本

我们已经获取到机器人的 IP 地址,这里我们仍以 Python 编程语言为例,编写脚本来完成 *建立控制连接,使能 SDK 模式* 功能
我们已经获取到机器人的 IP 地址,这里我们仍以 Python 编程语言为例,编写脚本来完成 *建立控制连接,打开 SDK 模式* 功能

参考代码如下

Expand Down
6 changes: 3 additions & 3 deletions docs/sdk/protocol_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ IN:**chassis push {[position <switch> pfreq <freq>][attitude <switch> afreq <f
OUT: **chassis push <attr> <data>**

- 描述
- 当用户使能底盘信息推送后,机器人会以设置的频率向用户推送相应信息
- 当用户打开底盘信息推送后,机器人会以设置的频率向用户推送相应信息
- 参数
- *attr* (:data:`chassis_push_attr_enum`) : 订阅的属性名称
- *data* : 订阅的属性数据
Expand Down Expand Up @@ -362,7 +362,7 @@ IN: **gimbal push <attr> <switch> [afreq <freq_all>]**
OUT: **gimabal push <attr> <data>**

- 描述
- 当用户使能云台信息推送后,机器人会以设置的频率向用户推送相应信息
- 当用户打开云台信息推送后,机器人会以设置的频率向用户推送相应信息
- 参数
- *attr* (:data:`gimbal_push_attr_enum`) : 订阅的属性名称
- *data*: 订阅的属性数据
Expand Down Expand Up @@ -508,7 +508,7 @@ OUT: **sound event <attr> <data>**

- 描述
- 当发生特定声音事件时,可以从事件推送端口接收到此数据
- 使能该事件请参见 `声音识别事件上报控制`_
- 打开该事件请参见 `声音识别事件上报控制`_
- 参数
- *attr* (:data:`sound_event_attr_enum`): 事件属性名称
- *data* :事件属性数据
Expand Down
4 changes: 2 additions & 2 deletions docs/sdk/protocol_struct.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ OUT: **<obj> push <attr> <value>**

- 描述
- 消息推送协议格式,通过控制命令打开某消息推送后即可接收到
- 消息推送将会以固定的频率进行的推送,推送频率取决于使能当前消息推送时的频率设置
- 消息推送将会以固定的频率进行的推送,推送频率取决于打开当前消息推送时的频率设置
- 参数
- *obj* (str): 推送对象
- *attr* (str): 推送数据属性
Expand All @@ -59,7 +59,7 @@ OUT: **<obj> event <attr> <value>**

.. note:: 触发机制

当成功使能对应 *事件上报* 功能后,若发生事件,则会进行一次事件上报
当成功打开对应 *事件上报* 功能后,若发生事件,则会进行一次事件上报

*****************
IP 广播
Expand Down