Skip to content

Commit 658be2f

Browse files
committed
Update cyclonedds installation guide.
1 parent 85456ca commit 658be2f

File tree

2 files changed

+76
-3
lines changed

2 files changed

+76
-3
lines changed

content/install-guides/cyclonedds.md

Lines changed: 75 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,83 @@ It is part of the Eclipse Foundation and is widely used in ROS 2 as a key middle
2323

2424
## Before you begin
2525

26+
ROS2 is available for Linux, macOS and Windows.
27+
This article provides a quick solution to install Cyclone DDS on Linux.
2628

29+
Confirm you are using an Arm machine by running:
2730

28-
## How do I Install ROS2 for Ubuntu on Arm?
31+
```bash
32+
uname -m
33+
```
2934

35+
The output should be:
3036

31-
## Quick test on ROS2
37+
```output
38+
aarch64
39+
```
3240

41+
If you see a different result, you are not using an Arm computer running 64-bit Linux.
42+
43+
Also, you need install following before building Cyclone DDS:
44+
45+
- C Compiler (i.e. GCC).
46+
- GIT.
47+
- CMAKE (3.7 or later).
48+
- OpenSSL (1.1 or later)
49+
50+
## How do I build Cyclone DDS on Arm?
51+
52+
We will install Cyclone DDS from source code.
53+
Clone the GitHub link and create a build folder.
54+
55+
```bash
56+
git clone https://github.com/eclipse-cyclonedds/cyclonedds.git
57+
```
58+
59+
Once download, you can build and install Cyclone DDS on Linux.
60+
In order to verify the installation, we enable `BUILD_EXAMPLES` and `BUILD_TESTING` for further testing.
61+
62+
```bash
63+
cd cyclonedds
64+
mkdir build
65+
cmake -DBUILD_EXAMPLES=ON -DBUILD_TESTING=ON -DCMAKE_INSTALL_PREFIX=<install-location> ..
66+
cmake --build .
67+
cmake --build . --target install
68+
```
69+
70+
{{% notice Note %}}
71+
The two cmake --build commands might require being executed with sudo depending on the <install-location>.
72+
{{% /notice %}}
73+
74+
75+
## Quick test on Cyclone DDS
76+
77+
After success build up the code, you are able to use Cyclone DDS now.
78+
To verify the installation, you can run the Hello World example on cyclonedds/build/bin folder.
79+
80+
Open two terminals and move to the cyclonedds/build/bin/ directory and in each terminal run:
81+
82+
{{< tabpane code=true >}}
83+
{{< tab header="Publisher" language="bash">}}
84+
cd cyclonedds/build/bin/
85+
./HelloworldPublisher
86+
{{< /tab >}}
87+
{{< tab header="Subscriber" language="bash">}}
88+
cd cyclonedds/build/bin/
89+
./HelloworldSubscriber
90+
{{< /tab >}}
91+
{{< /tabpane >}}
92+
93+
If you observe the following message from each of terminal, it's mean Cyclone DDS has been successfully installed on Arm machine.
94+
You are now ready to use Cyclone DDS.
95+
96+
{{< tabpane code=true >}}
97+
{{< tab header="Publisher" language="log">}}
98+
=== [Publisher] Waiting for a reader to be discovered ...
99+
=== [Publisher] Writing : Message (1, Hello World)
100+
{{< /tab >}}
101+
{{< tab header="Subscriber" language="log">}}
102+
=== [Subscriber] Waiting for a sample ...
103+
=== [Subscriber] Received : Message (1, Hello World)
104+
{{< /tab >}}
105+
{{< /tabpane >}}

content/install-guides/ros2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ ROS 2 is the latest version, designed to enhance security, improve distributed s
2323

2424
## Before you begin
2525

26-
ROS2 is available for Ubuntu Linux 22.04, 24.04 and Windows 110.
26+
ROS2 is available for Ubuntu Linux 22.04, 24.04 and Windows 11.
2727

2828
This article provides a quick solution to install ROS2 for Ubuntu on Arm.
2929

0 commit comments

Comments
 (0)