Skip to content

Commit

Permalink
Update documentation on ReverseInterface
Browse files Browse the repository at this point in the history
  • Loading branch information
fmauch committed Mar 25, 2021
1 parent c17cc53 commit ff73ba7
Showing 1 changed file with 2 additions and 7 deletions.
9 changes: 2 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -217,13 +217,8 @@ meant to send joint positions or velocities together with a mode that tells the
interpret those values (e.g. `SERVOJ`, `SPEEDJ`). Therefore, this interface can be used to do motion
command streaming to the robot.
Simultaneously this class offers a function to receive a keepalive signal from the robot. This
function expects to read a terminated string from the opened socket and returns the string that has
been read. If no string could be read, an empty string is returned instead.
In order to use this class in an application together with a robot, make sure that a corresponding
URScript is running on the robot that can interpret the commands sent and sends keepalive signals to
the interface. See [this example script](examples/resources/scriptfile.urscript) for reference.
URScript is running on the robot that can interpret the commands sent. See [this example script](examples/resources/scriptfile.urscript) for reference.
Also see the [ScriptSender](#scriptsender) for a way to define the corresponding URScript on the
control PC and sending it to the robot upon request.
Expand Down Expand Up @@ -384,4 +379,4 @@ If you compile this library against `console_bridge`, make sure to set the loggi
application, as by default `console_bridge` will only print messages of level WARNING or higher.
See [`examples/primary_pipeline.cpp`](examples/primary_pipeline.cpp) as an example.
The ROS logger will be moved to the ROS driver in a future release.
The ROS logger will be moved to the ROS driver in a future release.

0 comments on commit ff73ba7

Please sign in to comment.