Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
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 canopen/sphinx/user-guide/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ but come from the lely core library. Below you find a list of possible configura
:widths: 1 1

configuration item; description
node_id; The node-ID (default: 255)
node_id; The node-ID (e.g. 255)
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not specifying it in bus.yml gives an error.

driver; The fully qualified class name of the master to use.
package; The ros2 package name in which the master class can be found.
namespace; The namespace in which the master will be created (default: "/").
Expand Down
29 changes: 5 additions & 24 deletions canopen/sphinx/user-guide/how-to-create-a-configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ Bus configuration creation
.. code-block:: yaml

options:
dcf_path: install/{package_name}/share/{package_name}/config/{bus_config_name}
dcf_path: "@BUS_CONFIG_PATH@"
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is recommended I believe

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, this is correct.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, depends if #403 gets merged first 🙂


Then you need to define your master.

Expand All @@ -126,7 +126,7 @@ Bus configuration creation
.. code-block:: yaml

nodes:
- [unique slave name]:
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should not be a list but a map.

[unique slave name]:
node_id: [node id]
package: [ros2 package where to find the driver]
driver: [qualified name of the driver]
Expand All @@ -141,8 +141,7 @@ Create a launch folder in your package directory and a launch file.

.. code-block:: console

mkdir launch
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This directory was already created above.

touch {...}.launch.py
touch launch/{...}.launch.py
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added launch/ to indicate we're suddenly operating in different directories.


Add the following code:

Expand Down Expand Up @@ -216,26 +215,8 @@ Finally we need to adjust the CMakeLists.txt file to pick everything up correctl
cogen_dcf({bus_config_name})

install(DIRECTORY
launch/
DESTINATION share/${PROJECT_NAME}/launch/
launch
DESTINATION share/${PROJECT_NAME}
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is simply a cleanup. All other tutorials use this syntax, result is the same but this allows for more folders.

)

install(DIRECTORY
launch_tests/
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This directory simply does not exist.

DESTINATION share/${PROJECT_NAME}/launch_tests/
)


if(BUILD_TESTING)
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is just noise on the tutorial.

find_package(ament_lint_auto REQUIRED)
# the following line skips the linter which checks for copyrights
# comment the line when a copyright and license is added to all source files
set(ament_cmake_copyright_FOUND TRUE)
# the following line skips cpplint (only works in a git repo)
# comment the line when this package is in a git repo and when
# a copyright and license is added to all source files
set(ament_cmake_cpplint_FOUND TRUE)
ament_lint_auto_find_test_dependencies()
endif()

ament_package()