Skip to content

Commit 57bd94f

Browse files
committed
Add migration notes
1 parent 7140703 commit 57bd94f

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

doc/migration_notes.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
ur_client_library
2+
=================
3+
4+
This document contains notes on the migration of the ur_client_library between major versions.
5+
6+
It contains only breaking changes.
7+
8+
Migrating from 1.x.x to 2.x.x
9+
-----------------------------
10+
11+
- In the ``urcl::ExampleRobotWrapper`` class the ``ur_driver_``, ``dashboard_client`` and
12+
``primary_client`` members are now private. Use ``getUrDriver()``, ``getDashboardClient()`` and
13+
``getPrimaryClient()`` to access them.
14+
15+
- In ``urcl::comm::ControlModeTypes`` two member functions have been renamed:
16+
17+
- ``is_control_mode_realtime`` -> ``isControlModeRealtime``
18+
- ``is_control_mode_non_realtime`` -> ``isControlModeNonRealtime``
19+
20+
- In ``urcl::RobotReceiveTimeout`` the ``timeout_`` member is now private. Use
21+
``getAsMilliseconds()`` to access it.
22+
23+
- In ``urcl::UrDriverConfiguration`` two members have been renamed:
24+
25+
- ``rtde_initialization_attempts_`` -> ``rtde_initialization_attempts``
26+
- ``rtde_initialization_timeout_`` -> ``rtde_initialization_timeout``

0 commit comments

Comments
 (0)