这个文档是做什么的？

用于帮助搭建FastDDS测试用的环境，运行我们的代码。通过走完该步骤，你能够在你的linux上进行FastDDS-python绑定的代码测试和开发。注：教程中有些步骤可能是冗余的，如果你的水平够高，可以尝试忽略。

仓库地址: https://github.com/S1yang/Fastdds_beginner

该文档包含以下的一些软件的入门要求，在此基础上尽量做到通俗易懂：

VScode

Linux(ubuntu-22.04)和Vmware

python与anaconda

more...

1 安装Linux操作系统

我们的代码运行在linux上，为了在windows上进行开发和代码调试，你需要运行linux虚拟机，有两种方式，一种是Vmware(推荐)，另一种是wsl。为此，你需要一个linux镜像，我使用的是 ubuntu-22.04 LTS （推荐使用：ubuntu-22.04.3-live-server-amd64.iso）

1.1 Vmware虚拟机

1.1.1虚拟机的下载和安装

虚拟机安装包下载链接： https://pan.baidu.com/s/1fmgsY5-qFn-_WzJs31Q8lg 提取码：xiao

虚拟机安装网址：vmware下载_vmware下载免费中文版客户端[虚拟机]-下载之家 (downza.cn)

密钥：JU090-6039P-08409-8J0QH-2YR7F

[注意]这里最好开8个G的内存

其他未经标注的地方，一律done。

创建并运行一个虚拟机后，你需要安装vmtools，这部分可以参考GPT给的答案：

在 Ubuntu 虚拟机上安装 VMware Tools 可以提高虚拟机的性能和用户体验，例如改善鼠标性能、提供更好的屏幕分辨率支持和共享文件夹功能。以下是在 Ubuntu 上安装 VMware Tools 的步骤：

方法 1: 使用 VMware 提供的安装程序

启动 Ubuntu 虚拟机 。

在 VMware 的菜单栏中，选择 虚拟机 > 安装 VMware Tools 。这将挂载 VMware Tools 的 ISO 到 Ubuntu 虚拟机中的光驱。

在 Ubuntu 中，打开一个终端窗口。

创建一个挂载点并挂载 VMware Tools 的 ISO 文件（如果系统没有自动挂载的话）：

mkdir -p /mnt/cdrom
sudo mount /dev/cdrom /mnt/cdrom

进入挂载目录，并解压 VMware Tools 的安装包：

cd /mnt/cdrom
tar xzvf VMwareTools-*.tar.gz -C /tmp

运行 VMware Tools 的安装脚本：

cd /tmp/vmware-tools-distrib
sudo ./vmware-install.pl

按照屏幕上的提示操作。大多数情况下，可以接受默认设置。

安装完成后，卸载 ISO 并重启虚拟机：

sudo umount /mnt/cdrom
reboot

方法 2: 使用开源版本 Open-VM-Tools (推荐)

对于大多数 Linux 发行版，包括 Ubuntu，推荐使用开源版本的 VMware Tools，即 open-vm-tools ，因为它更容易安装且通常包含在发行版的软件仓库中。

打开一个终端窗口。

使用以下命令安装 open-vm-tools ：

sudo apt update
sudo apt install open-vm-tools

如果您运行的是 Ubuntu 桌面版，并希望在虚拟机和宿主机之间共享剪贴板和文件，则还需要安装 open-vm-tools-desktop ：

sudo apt install open-vm-tools-desktop

安装完成后，重启虚拟机以确保所有模块都正确加载：

reboot

使用 open-vm-tools 是在 Ubuntu 虚拟机上安装 VMware Tools 的推荐方法，因为它能够提供与 VMware 提供的原版 VMware Tools 相同的主要功能，且安装过程更简单、更快捷。

安装成功后，你可以输入如下指令来进行验证。

vmware-toolbox-cmd -v

1.1.2 使用terminus来与你的虚拟机交互（可选）

使用terminus来管理你的终端，实现 更舒服 的交互。要实现这项功能，你需要在安装的时候把OpenSSH装上，然后你可能需要输入 ip addr来拿到SSH的地址。 通过SSH进行cmd交互 通过ftp进行文件的传输和文件的管理

1.2 WSL虚拟机（弃用）

相比于Vmware，WSL的优点是方便你可以直接使用主机的vscode或其他的编辑器去修改代码进行测试，可以直接通过windows的文件夹访问到linux文件夹。

但是它有个缺点， 它的网络模式使得我还没解决两台WSL虚拟机进行网络通信的问题 ，这个问题使得我们不能进行多机的DDS代码调试。所以该方法基本上已经被弃用了。

2 miniconda的安装

miniconda是anaconda的精简版本，在此处可以进行安装。

安装后，刷新一下环境变量

source ~/.bashrc

当出现(base)时，说明我们的conda已经装好了。接着我们创建一个我们代码运行需要的环境，并激活该环境，最好将该环境直接添加到启动脚本里去。

要使用Conda创建一个名为 ddsT 的环境，并指定Python版本为3.11.5，您可以在终端或命令提示符中运行以下命令：

conda create --name ddsT python=3.11.5

这将创建一个新的Conda环境，并安装指定版本的Python。一旦环境创建完成，您可以使用以下命令来激活该环境：

conda activate ddsT

激活环境后，您可以在该环境中安装其他所需的包或进行其他操作。当您完成工作并想退出环境时，可以使用以下命令：

conda deactivate

在bashrc中添加conda activate ddsT，以让你登录就进到该环境当中

sudo apt install nano
nano ~/.bashrc

source ~/.bashrc

到目前为止，确保你正确地安装了conda，并创建了一个python==3.11.5的环境，你在linux下激活了该环境，这样我们就可以进行到下一步。

3 FastDDS-python绑定的安装

此为该文档中最重要也是内容最多的一步，由于原本的教程写的很散乱，且会遇到大大小小的坑，故在此对整个流程进行梳理。

3.1 依赖项的安装

sudo apt install cmake g++ python3-pip wget git
sudo apt install libasio-dev libtinyxml2-dev
sudo apt install libssl-dev

3.2 Fast DDS Python bindings 安装

注意：为了防止你遇到第4.2节的运行错误却又受限于虚拟机性能过不去，最好运行如下命令：

 conda install -c conda-forge libstdcxx-ng

具体可以见本文4.2节详细描述。

接下来，在你的conda环境下安装用于fastdds编译和安装的包

pip3 install -U colcon-common-extensions vcstool

这一步时间比较长

sudo apt install swig
sudo apt install libpython3-dev

mkdir ~/Fast-DDS-python
cd ~/Fast-DDS-python
wget https://raw.githubusercontent.com/eProsima/Fast-DDS-python/main/fastdds_python.repos
mkdir src
vcs import src < fastdds_python.repos

这一步有个坑点，wget那一步下载不下来，你可以去这个网站上把这个链接中的文本复制下来，然后在本地创建一个fastrtps.repos，把文件内容写进去：

touch fastdds_python.repos
nano fastdds_python.repos

repositories:
    foonathan_memory_vendor:
        type: git
        url: https://github.com/eProsima/foonathan_memory_vendor.git
        version: master
    fastcdr:
        type: git
        url: https://github.com/eProsima/Fast-CDR.git
        version: master
    fastdds:
        type: git
        url: https://github.com/eProsima/Fast-DDS.git
        version: master
    fastdds_python:
        type: git
        url: https://github.com/eProsima/Fast-DDS-python.git
        version: main
    fastddsgen:
        type: git
        url: https://github.com/eProsima/Fast-DDS-Gen.git
        version: master
    fastddsgen/thirdparty/idl-parser:
        type: git
        url: https://github.com/eProsima/IDL-Parser.git
        version: master
最后一步从vcs导入也特别容因为网络问题导错，你可以在我上传的文件夹里找到完整的。
如果是如下的过程，就说明是成功的：
然后，接着在这个Fast-DDS-python目录上，运行如下命令编译：
注：这个编译过程比较长，耐心等待。
colcon build




    

以下是一次编译运行成功的log，这涉及到一些警告，但没有有太大问题：
(ddsT) remake@remake:~/Fast-DDS-python$ colcon build
[0.338s] WARNING:colcon.colcon_core.verb:No task extension to 'build' a 'gradle' package
Starting >>> fastcdr 
Starting >>> foonathan_memory_vendor
Finished <<< fastcdr [2.76s]                                                                            
--- stderr: foonathan_memory_vendor                                
Cloning into 'foo_mem-ext'...
HEAD is now at 0f07757 Release 0.7-3
Finished <<< foonathan_memory_vendor [26.4s]
Starting >>> fastrtps
[Processing: fastrtps]                             
[Processing: fastrtps]                                      
[Processing: fastrtps]                                       
[Processing: fastrtps]                                       
[Processing: fastrtps]                                       
[Processing: fastrtps]                                       
[Processing: fastrtps]                                       
[Processing: fastrtps]                                       
[Processing: fastrtps]                                       
Finished <<< fastrtps [4min 38s]                             
Starting >>> fastdds_python
--- stderr: fastdds_python                                     
/home/remake/Fast-DDS-python/install/fastrtps/include/fastdds/dds/core/policy/QosPolicies.hpp:1362: Warning 325: Nested class not currently supported (const_iterator ignored)
/home/remake/Fast-DDS-python/install/fastrtps/include/fastdds/rtps/common/LocatorList.hpp:45: Warning 401: Nothing known about base class 'LocatorsIterator'. Ignored.
/home/remake/Fast-DDS-python/install/fastrtps/include/fastdds/dds/core/LoanableSequence.hpp:1: Warning 401: Nothing known about base class 'LoanableTypedCollection< eprosima::fastdds::dds::SampleInfo,std::true_type >'. Ignored.
/home/remake/Fast-DDS-python/install/fastrtps/include/fastdds/dds/core/LoanableSequence.hpp:1: Warning 401: Maybe you forgot to instantiate 'LoanableTypedCollection< eprosima::fastdds::dds::SampleInfo,std::true_type >' using %template.
/home/remake/Fast-DDS-python/install/fastrtps/include/fastdds/rtps/common/Time_t.h:87: Warning 509: Overloaded method eprosima::fastrtps::Time_t::is_infinite(eprosima::fastrtps::Time_t const &) effectively ignored,
/home/remake/Fast-DDS-python/install/fastrtps/include/fastdds/rtps/common/Time_t.h:73: Warning 509: as it is shadowed by eprosima::fastrtps::Time_t::is_infinite() const.
/home/remake/Fast-DDS-python/install/fastrtps/include/fastdds/rtps/common/Time_t.h:145: Warning 509: Overloaded method eprosima::fastrtps::rtps::Time_t::seconds() effectively ignored,
/home/remake/Fast-DDS-python/install/fastrtps/include/fastdds/rtps/common/Time_t.h:140: Warning 509: as it is shadowed by eprosima::fastrtps::rtps::Time_t::seconds() const.
/home/remake/Fast-DDS-python/install/fastrtps/include/fastdds/rtps/common/Time_t.h:172: Warning 509: Overloaded method eprosima::fastrtps::rtps::Time_t::fraction() effectively ignored,
/home/remake/Fast-DDS-python/install/fastrtps/include/fastdds/rtps/common/Time_t.h:167: Warning 509: as it is shadowed by eprosima::fastrtps::rtps::Time_t::fraction() const.
/home/remake/Fast-DDS-python/install/fastrtps/include/fastdds/rtps/common/WriteParams.h:151: Warning 509: Overloaded method eprosima::fastrtps::rtps::WriteParams::source_timestamp() effectively ignored,
/home/remake/Fast-DDS-python/install/fastrtps/include/fastdds/rtps/common/WriteParams.h:141: Warning 509: as it is shadowed by eprosima::fastrtps::rtps::WriteParams::source_timestamp() const.
/home/remake/Fast-DDS-python/install/fastrtps/include/fastdds/rtps/common/WriteParams.h:179: Warning 509: Overloaded method eprosima::fastrtps::rtps::WriteParams::source_timestamp(eprosima::fastrtps::rtps::Time_t &&) effectively ignored,
/home/remake/Fast-DDS-python/install/fastrtps/include/fastdds/rtps/common/WriteParams.h:165: Warning 509: as it is shadowed by eprosima::fastrtps::rtps::WriteParams::source_timestamp(eprosima::fastrtps::rtps::Time_t const &).
/home/remake/Fast-DDS-python/install/fastrtps/include/fastdds/dds/core/policy/QosPolicies.hpp:2027: Warning 451: Setting a const char * variable may leak memory.
/home/remake/Fast-DDS-python/build/fastdds_python/src/swig/CMakeFiles/fastdds_python.dir/fastddsPYTHON_wrap.cxx: In function ‘PyObject* PyInit__fastdds_python()’:
/home/remake/Fast-DDS-python/build/fastdds_python/src/swig/CMakeFiles/fastdds_python.dir/fastddsPYTHON_wrap.cxx:982:64: warning: ‘void PyEval_InitThreads()’ is deprecated [-Wdeprecated-declarations]
  982 | #     define SWIG_PYTHON_INITIALIZE_THREADS  PyEval_InitThreads()
      |                                              ~~~~~~~~~~~~~~~~~~^~
/home/remake/Fast-DDS-python/build/fastdds_python/src/swig/CMakeFiles/fastdds_python.dir/fastddsPYTHON_wrap.cxx:151206:3: note: in expansion of macro ‘SWIG_PYTHON_INITIALIZE_THREADS’
151206 |   SWIG_PYTHON_INITIALIZE_THREADS;
       |   ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
In file included from /home/remake/miniconda3/envs/ddsT/include/python3.11/Python.h:95,
                 from /home/remake/Fast-DDS-python/build/fastdds_python/src/swig/CMakeFiles/fastdds_python.dir/fastddsPYTHON_wrap.cxx:180:
/home/remake/miniconda3/envs/ddsT/include/python3.11/ceval.h:132:37: note: declared here
  132 | Py_DEPRECATED(3.9) PyAPI_FUNC(void) PyEval_InitThreads(void);
      |                                     ^~~~~~~~~~~~~~~~~~
/home/remake/Fast-DDS-python/build/fastdds_python/src/swig/CMakeFiles/fastdds_python.dir/fastddsPYTHON_wrap.cxx: In function ‘PyObject* _wrap_delete_InstanceHandleValue_t(PyObject*, PyObject*)’:
/home/remake/Fast-DDS-python/build/fastdds_python/src/swig/CMakeFiles/fastdds_python.dir/fastddsPYTHON_wrap.cxx:31560:16: warning: ‘void operator delete(void*, std::size_t)’ called on unallocated object ‘temp1’ [-Wfree-nonheap-object]
31560 |         delete arg1;
      |                ^~~~
/home/remake/Fast-DDS-python/build/fastdds_python/src/swig/CMakeFiles/fastdds_python.dir/fastddsPYTHON_wrap.cxx:31532:51: note: declared here
31532 |   eprosima::fastrtps::rtps::InstanceHandleValue_t temp1 ;
      |                                                   ^~~~~
Finished <<< fastdds_python [22.0s]
Starting >>> fastdds_python_examples
--- stderr: fastdds_python_examples                                    
/home/remake/Fast-DDS-python/install/fastrtps/include/fastdds/dds/core/LoanableTypedCollection.hpp:68: Warning 389: operator[] ignored (consider using %extend)
/home/remake/Fast-DDS-python/install/fastrtps/include/fastdds/dds/core/LoanableTypedCollection.hpp:93: Warning 389: operator[] ignored (consider using %extend)
Finished <<< fastdds_python_examples [4.60s]
Summary: 5 packages finished [5min 31s]
  3 packages had stderr output: fastdds_python fastdds_python_examples foonathan_memory_vendor
将你装好的东西添加到环境变量
echo 'source ~/Fast-DDS-python/install/setup.bash' >> ~/.bashrc
3.3 Fast DDS-Gen 安装

如果你在1.3.2步的源代码导入没问题，你可以在/Fast-DDS-python/src/fastddsgen下找到这个用于安装的文件夹而不用再次下载。
sudo apt install openjdk-11-jdk
./gradlew assemble
这一步基本运行不了，因为它无法从网络上下来分发，你可以在网站上把分发包下下来。
然后按照我接下来的步骤进行修改：
找到或下载 Gradle 分发包：首先，确保您有 Gradle 的 .zip 分发包，并记下它在您本地文件系统上的绝对路径。比如，如果您的分发包位于 /path/to/gradle-7.6-bin.zip。
修改 gradle-wrapper.properties 文件：找到您项目中的 gradle-wrapper.properties 文件，这个文件通常位于 gradle/wrapper 目录下。
更新 distributionUrl：在 gradle-wrapper.properties 文件中，将 distributionUrl 属性的值更改为指向您本地 Gradle 分发包的 file:// URL。确保使用正确的路径并遵循 file:// 协议的格式。例如：
distributionUrl=file:///home/remake/Fast-DDS-python/src/fastddsgen/gradle/wrapper/gradle-7.6-bin.zip
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=file:///home/remake/Fast-DDS-python/src/fastddsgen/gradle/wrapper/gradle-7.6-bin.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
接着，继续该命令：
最后，把scripts文件夹添加到环境变量：
nano ~/.bashrc
export PATH="$PATH:/home/remake/Fast-DDS-python/src/fastddsgen/scripts"
source ~/.bashrc
如果你的fastddsgen安装成功，命令窗口输入fastddsgen应该有回应：
4 FastDDS-例程的使用

当你正确地安装了fastDDS的python绑定后，便可以尝试运行例程。
4.1 为.idl文件生成python-C艹绑定

将dds_test_example文件夹复制到你的虚拟机中，并进入该目录。
接着，生成在 C++11 中实现此数据类型的源代码以及用于 Python 绑定的 SWIG 接口文件。
fastddsgen -python DataSet.idl
接着，使用cmake生成python绑定，必须成功生成与.idl同名的.py文件
cmake .
4.2 运行例程代码

运行我们写好的例程代码：
python Node1.py
你可能会碰到一个错误：
(ddsT) remake@remake:~/dds_test_example$ python Node1.py
Traceback (most recent call last):
  File "/home/remake/dds_test_example/Node1.py", line 2, in <module>
    from machine import DDSMachine
  File "/home/remake/dds_test_example/machine.py", line 3, in <module>
    import fastdds
  File "/home/remake/Fast-DDS-python/install/fastdds_python/lib/python3.11/site-packages/fastdds.py", line 15, in <module>
    import _fastdds_python
ImportError: /home/remake/miniconda3/envs/ddsT/bin/../lib/libstdc++.so.6: version `GLIBCXX_3.4.30' not found (required by /home/remake/Fast-DDS-python/install/fastrtps/lib/libfastrtps.so.2.13)
因为我们使用的是conda，故在conda中强制安装一个兼容版本的libstdc++库来解决这个问题:
conda install -c conda-forge libstdcxx-ng
注意：这一步中，如果你的虚拟机是4GB内存，很有可能会导致内存不够用而更新失败。如果你实在不能为虚拟机分配更多内存，你可以尝试使用虚拟内存或者其他方法来解决此问题。
如果你在这步过不去，而又受限机器性能，建议你创建并使用一个新的conda环境，回到本文的第3.2节，在进行pip3 install -U colcon-common-extensions vcstool之前运行该句！
继续运行我们写好的例程代码：
python Node1.py
python Node2.py
你需要打开两个终端，一个运行Node1，一个运行Node2。Node1是发布者，用于产生数据并发布，Node2是订阅者，用于收到数据并打印。
5 在两台虚拟机上进行FastDDS通信

为了测试dds的多机通信，我们使用两台虚拟机，一台运行Node1，一台运行Node2。为了防止你重走之前的过程，在这里直接将我们已经配置好的虚拟机克隆一份。
当然，克隆过来的虚拟机并不能够拿来直接用，所以请仔细看下面的步骤。
5.1 克隆虚拟机并正确设置其网络

关闭虚拟机并克隆
将两台虚拟机都启动
由于克隆过来的虚拟机使用了之前机的ip地址，这会导致网络冲突，所以我们要在克隆机上进行操作，让它获取新的IP地址。
使用 dhclient 命令

dhclient 是一个常用的命令行工具，用于配置和管理网络接口的 DHCP 设置。您可以使用它来释放当前的 IP 地址并请求一个新的地址。
释放当前 IP 地址：
sudo dhclient -r
这个命令会释放指定网络接口上的当前 DHCP 租约。如果您想指定特定的网络接口（比如 eth0），可以使用：
sudo dhclient -r eth0
重新获取 IP 地址：
sudo dhclient
同样，如果需要针对特定接口，使用：
sudo dhclient eth0
操作完成后，重启克隆机
reboot
你可以看到，克隆机获取了一个新的ip地址。
5.2 在终端上进行多机测试

接下来，你可以在terminus上分别连接两个终端
接着，运行我们的代码：
这样，你就完成了在VMware上使用两个虚拟机进行dds多机测试的步骤!
5.3 additional tips

克隆的虚拟机由于复制了所有的东西，有可能在其他地方会引起冲突，例如完全一致的主机名、用户账户等。你可以查阅相关资料解决这些冲突。
在走完我们整个教程后，建议你将其作为最原始的虚拟机系统备份，如果你需要在虚拟机上使用pycharm或者其他ide来对代码进行开发，又或是想要安装其他的环境或者软件，建议你在克隆机上进行。
这种网络通信建立在虚拟机以NAT模式进行(一般是vm的默认模式)的情况下，如果你的vmware默认设置的是其他模式，你需要将其修改过来。
vm虚拟机资源:https://www.bilibili.com/video/BV1Vg4y1w7Es
Linux installation from sources:https://fast-dds.docs.eprosima.com/en/latest/installation/sources/sources_linux.html
Writing a simple Python publisher and subscriber application:https://fast-dds.docs.eprosima.com/en/latest/fastdds/getting_started/simple_python_app/simple_python_app.html#
ChatGPT:https://chat.openai.com/

Name		Name	Last commit message	Last commit date
Latest commit History 16 Commits
Fast-DDS-python		Fast-DDS-python
dds_test_example		dds_test_example
img		img
readme.md		readme.md

Repository files navigation

这个文档是做什么的？

1 安装Linux操作系统

1.1 Vmware虚拟机

1.1.1虚拟机的下载和安装

方法 1: 使用 VMware 提供的安装程序

方法 2: 使用开源版本 Open-VM-Tools (推荐)

1.1.2 使用terminus来与你的虚拟机交互（可选）

1.2 WSL虚拟机（弃用）

2 miniconda的安装

3 FastDDS-python绑定的安装

3.1 依赖项的安装

3.2 Fast DDS Python bindings 安装

3.3 Fast DDS-Gen 安装

4 FastDDS-例程的使用

4.1 为.idl文件生成python-C艹绑定

4.2 运行例程代码

5 在两台虚拟机上进行FastDDS通信

5.1 克隆虚拟机并正确设置其网络

使用 `dhclient` 命令

5.2 在终端上进行多机测试

5.3 additional tips

Folders and files

Latest commit

History

Repository files navigation

这个文档是做什么的？

1 安装Linux操作系统

1.1 Vmware虚拟机

1.1.1虚拟机的下载和安装

方法 1: 使用 VMware 提供的安装程序

方法 2: 使用开源版本 Open-VM-Tools (推荐)

1.1.2 使用terminus来与你的虚拟机交互（可选）

1.2 WSL虚拟机（弃用）

2 miniconda的安装

3 FastDDS-python绑定的安装

3.1 依赖项的安装

3.2 Fast DDS Python bindings 安装

3.3 Fast DDS-Gen 安装

4 FastDDS-例程的使用

4.1 为.idl文件生成python-C艹绑定

4.2 运行例程代码

5 在两台虚拟机上进行FastDDS通信

5.1 克隆虚拟机并正确设置其网络

使用 dhclient 命令

5.2 在终端上进行多机测试

5.3 additional tips

使用 `dhclient` 命令