Skip to content

Commit 22df3c8

Browse files
Felix Exnerfmauch
authored andcommitted
Added section about logging possibilities to README
1 parent 71885a9 commit 22df3c8

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -272,3 +272,17 @@ consumer/producer pattern. The Producer reads data from the socket whenever it c
272272
contents and stores the parsed packages into a pipeline queue.
273273
You can write your own consumers that use the packages coming from the producer. See the
274274
[`comm::ShellConsumer`](include/ur_client_library/comm/shell_consumer.h) as an example.
275+
276+
## Logging configuration
277+
As this library was originally designed to be included into a ROS driver but also to be used as a
278+
standalone library, it uses custom logging macros instead of direct `printf` or `std::cout`
279+
statements.
280+
281+
These logging macros will either be translated into `printf` statements or logging commands of
282+
[`console_bridge`](https://github.com/ros/console_bridge) if `console_bridge` is found on the system
283+
during the cmake run. In this case, the define `ROS_BUILD` will be set.When built inside a catkin
284+
workspace, logging commands are automatically translated into ROS logging commands.
285+
286+
Whenever you compile this library against `console_bridge`, make sure to set the logging level in
287+
your application, as by default `console_bridge` will only print messages of level WARNING or
288+
higher. See [`examples/primary_pipeline.cpp`](examples/primary_pipeline.cpp) as an example.

0 commit comments

Comments
 (0)