Skip to content

Commit f3537b1

Browse files
authored
Clarify limitations and dependencies #1
* Clarify limitations and dependencies Signed-off-by: Iker Luengo <ikerluengo@eprosima.com> * Link to fastdds gen documentation Signed-off-by: Iker Luengo <ikerluengo@eprosima.com>
1 parent 18fcb89 commit f3537b1

1 file changed

Lines changed: 17 additions & 5 deletions

File tree

README.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Python binding for Fast DDS Statistics Backend
1+
# Python binding for Fast DDS
22

33
<a href="http://www.eprosima.com"><img src="https://encrypted-tbn3.gstatic.com/images?q=tbn:ANd9GcSd0PDlVz1U_7MgdTe0FRIWD0Jc9_YH-gGi0ZpLkr-qgCI6ZEoJZ5GBqQ" align="left" hspace="8" vspace="2" width="100" height="100" ></a>
44

@@ -25,6 +25,7 @@ pip install -U colcon-common-extensions vcstool
2525
*Fast DDS Python* depends on [Fast DDS](https://github.com/eProsima/Fast-DDS) and [Fast CDR](https://github.com/eProsima/Fast-CDR).
2626
For simplicity, this tutorial will build these dependencies alongside the binding itself.
2727
More advanced users can build or link to this packages separately.
28+
2829
Install *Fast DDS* dependencies running:
2930

3031
```bash
@@ -34,14 +35,22 @@ sudo apt install -y \
3435
libtinyxml2-dev
3536
```
3637

38+
Additionally, *Fast DDS Python* also depends on [SWIG](http://www.swig.org/) and python3-dev. Install these dependencies running:
39+
```bash
40+
sudo apt update
41+
sudo apt install -y \
42+
swig \
43+
libpython3-dev
44+
```
45+
3746
### Build and install
3847

3948
```bash
4049
# Change directory to the location where the colcon workspace will be created
4150
cd <path_to_ws>
4251
# Create workspace directory
43-
mkdir -p fastdds_statistics_backend_ws/src
44-
cd fastdds_statistics_backend_ws
52+
mkdir -p fastdds_python_ws/src
53+
cd fastdds_python_ws
4554
# Get workspace setup file
4655
wget https://raw.githubusercontent.com/eProsima/Fast-DDS-python/main/fastdds_python.repos
4756
# Download repositories
@@ -54,8 +63,11 @@ colcon build
5463

5564
This project is on the very early stages of development, and there are many features not available yet. These include, but are not restricted to:
5665

57-
* QoS modification is not supported on python. If you need to use non-default QoS, please use XML configuration files.
66+
* QoS modification is not supported on python. It is possible to create a QoS object with the default constructor
67+
or retrieve it with the `get_qos` methods of the entities, but it is not possible to modify the QoS values.
68+
If you need to use non-default QoS, please use XML configuration files.
5869
* Status listeners are not available. Even though python will not complain if you add a listener to an entity, the listener will not be triggered.
70+
* Support in [*Fast DDS gen*](https://fast-dds.docs.eprosima.com/en/latest/fastddsgen/usage/usage.html) is also limited to structs of simple types (no nested structs nor arrays or maps).
5971

6072

6173
## Python example
@@ -74,7 +86,7 @@ struct HelloWorld
7486
};
7587
```
7688

77-
Use [*Fast DDS gen*](https://github.com/eProsima/Fast-DDS-Gen) to generate the necessary files from this IDL. If you installed *Fast DDS Python* using the `fastdds_python.repos` file, you will find *Fast DDS Gen* in the `src` file. Do not forget to use the `-python` option to create the files needed for the python binding:
89+
Use [*Fast DDS gen*](https://fast-dds.docs.eprosima.com/en/latest/fastddsgen/usage/usage.html) to generate the necessary files from this IDL. If you installed *Fast DDS Python* using the `fastdds_python.repos` file, you will find *Fast DDS Gen* in the `src` file. Do not forget to use the `-python` option to create the files needed for the python binding:
7890

7991
```bash
8092
fastddsgen -python HelloWorld.idl

0 commit comments

Comments
 (0)