Bases: PyBulletBase, ClientInterface
Interface to use pybullet as backend.
-compasfab.backends.PyBulletClient is a context manager type, so it’s best
+
compas_fab.backends.PyBulletClient is a context manager type, so it’s best
used in combination with the with statement to ensure
resource deallocation.
Thanks to Yijiang Huang and his work in pybullet_planning for much inspiration.
@@ -653,7 +653,7 @@ PyBulletClient
body_from_obj
|
Create a PyBullet body from an OBJ file. |
-cache_robot
|
+
cache_robot_model
|
Saves an editable copy of the robot's model and its meshes for shadowing the state of the robot on the PyBullet server. |
check_collision_objects_for_collision
|
@@ -671,21 +671,21 @@ PyBulletClient
convert_mesh_to_body
|
Convert compas mesh and its frame to a pybullet body. |
-ensure_cached_robot
|
+
ensure_cached_robot_model
|
Checks if a compas_fab.robots.Robot has been cached for use with PyBullet. |
-ensure_cached_robot_geometry
|
+
ensure_cached_robot_model_geometry
|
Checks if the geometry of a compas_fab.robots.Robot has been cached for use with PyBullet. |
filter_configurations_in_collision
|
Filters from a list of configurations those which are in collision. |
-get_cached_robot
|
-Returns the editable copy of the robot's model for shadowing the state of the robot on the PyBullet server. |
-
-get_cached_robot_filepath
|
+
get_cached_robot_filepath
|
Returns the filepath of the editable copy of the robot's model for shadowing the state of the robot on the PyBullet server. |
+get_cached_robot_model
|
+Returns the editable copy of the robot's model for shadowing the state of the robot on the PyBullet server. |
+
get_robot_configuration
|
Gets the robot's current pose. |
diff --git a/latest/api/generated/compas_fab.backends.PyBulletClient.inverse_kinematics.html b/latest/api/generated/compas_fab.backends.PyBulletClient.inverse_kinematics.html
index ac0965c9b..4bf173a8a 100644
--- a/latest/api/generated/compas_fab.backends.PyBulletClient.inverse_kinematics.html
+++ b/latest/api/generated/compas_fab.backends.PyBulletClient.inverse_kinematics.html
@@ -623,7 +623,7 @@
PyBulletClient.inverse_kinematics
-
-PyBulletClient.inverse_kinematics(*args, **kwargs)[source]
+PyBulletClient.inverse_kinematics(*args, **kwargs)[source]
Forwards call to appropriate method in the planner.
diff --git a/latest/api/generated/compas_fab.backends.PyBulletClient.load_robot.html b/latest/api/generated/compas_fab.backends.PyBulletClient.load_robot.html
index f37a87fa2..78ca10612 100644
--- a/latest/api/generated/compas_fab.backends.PyBulletClient.load_robot.html
+++ b/latest/api/generated/compas_fab.backends.PyBulletClient.load_robot.html
@@ -623,7 +623,7 @@
PyBulletClient.load_robot
-
-PyBulletClient.load_robot(urdf_file, resource_loaders=None, concavity=False, precision=None)[source]
+PyBulletClient.load_robot(urdf_file, resource_loaders=None, concavity=False, precision=None)[source]
Create a pybullet robot using the input urdf file.
- Parameters:
diff --git a/latest/api/generated/compas_fab.backends.PyBulletClient.load_semantics.html b/latest/api/generated/compas_fab.backends.PyBulletClient.load_semantics.html
index f4a878f07..581259a54 100644
--- a/latest/api/generated/compas_fab.backends.PyBulletClient.load_semantics.html
+++ b/latest/api/generated/compas_fab.backends.PyBulletClient.load_semantics.html
@@ -623,7 +623,7 @@
PyBulletClient.load_semantics
-
-PyBulletClient.load_semantics(robot, srdf_filename)[source]
+PyBulletClient.load_semantics(robot, srdf_filename)[source]
Loads the semantic information of a robot.
- Parameters:
diff --git a/latest/api/generated/compas_fab.backends.PyBulletClient.load_ur5.html b/latest/api/generated/compas_fab.backends.PyBulletClient.load_ur5.html
index c798dd98a..82fb04689 100644
--- a/latest/api/generated/compas_fab.backends.PyBulletClient.load_ur5.html
+++ b/latest/api/generated/compas_fab.backends.PyBulletClient.load_ur5.html
@@ -623,7 +623,7 @@
PyBulletClient.load_ur5
-
-PyBulletClient.load_ur5(load_geometry=False, concavity=False)[source]
+PyBulletClient.load_ur5(load_geometry=False, concavity=False)[source]
“Load a UR5 robot to PyBullet.
- Parameters:
diff --git a/latest/api/generated/compas_fab.backends.PyBulletClient.plan_cartesian_motion.html b/latest/api/generated/compas_fab.backends.PyBulletClient.plan_cartesian_motion.html
index 560f206b8..272370cd1 100644
--- a/latest/api/generated/compas_fab.backends.PyBulletClient.plan_cartesian_motion.html
+++ b/latest/api/generated/compas_fab.backends.PyBulletClient.plan_cartesian_motion.html
@@ -623,7 +623,7 @@
PyBulletClient.plan_cartesian_motion
-
-PyBulletClient.plan_cartesian_motion(*args, **kwargs)[source]
+PyBulletClient.plan_cartesian_motion(*args, **kwargs)[source]
Forwards call to appropriate method in the planner.
diff --git a/latest/api/generated/compas_fab.backends.PyBulletClient.plan_motion.html b/latest/api/generated/compas_fab.backends.PyBulletClient.plan_motion.html
index 692468097..6616158c3 100644
--- a/latest/api/generated/compas_fab.backends.PyBulletClient.plan_motion.html
+++ b/latest/api/generated/compas_fab.backends.PyBulletClient.plan_motion.html
@@ -623,7 +623,7 @@
PyBulletClient.plan_motion
-
-PyBulletClient.plan_motion(*args, **kwargs)[source]
+PyBulletClient.plan_motion(*args, **kwargs)[source]
Forwards call to appropriate method in the planner.
diff --git a/latest/api/generated/compas_fab.backends.PyBulletClient.reload_from_cache.html b/latest/api/generated/compas_fab.backends.PyBulletClient.reload_from_cache.html
index 3bc1343b2..37c9850d1 100644
--- a/latest/api/generated/compas_fab.backends.PyBulletClient.reload_from_cache.html
+++ b/latest/api/generated/compas_fab.backends.PyBulletClient.reload_from_cache.html
@@ -623,7 +623,7 @@
PyBulletClient.reload_from_cache
-
-PyBulletClient.reload_from_cache(robot)[source]
+PyBulletClient.reload_from_cache(robot)[source]
Reloads the PyBullet server with the robot’s cached model.
- Parameters:
diff --git a/latest/api/generated/compas_fab.backends.PyBulletClient.remove_attached_collision_mesh.html b/latest/api/generated/compas_fab.backends.PyBulletClient.remove_attached_collision_mesh.html
index 6b006b6fb..3fc791e4c 100644
--- a/latest/api/generated/compas_fab.backends.PyBulletClient.remove_attached_collision_mesh.html
+++ b/latest/api/generated/compas_fab.backends.PyBulletClient.remove_attached_collision_mesh.html
@@ -623,7 +623,7 @@
PyBulletClient.remove_attached_collision_mesh
-
-PyBulletClient.remove_attached_collision_mesh(*args, **kwargs)[source]
+PyBulletClient.remove_attached_collision_mesh(*args, **kwargs)[source]
Forwards call to appropriate method in the planner.
diff --git a/latest/api/generated/compas_fab.backends.PyBulletClient.remove_collision_mesh.html b/latest/api/generated/compas_fab.backends.PyBulletClient.remove_collision_mesh.html
index c973188e9..5b143880c 100644
--- a/latest/api/generated/compas_fab.backends.PyBulletClient.remove_collision_mesh.html
+++ b/latest/api/generated/compas_fab.backends.PyBulletClient.remove_collision_mesh.html
@@ -623,7 +623,7 @@
PyBulletClient.remove_collision_mesh
-
-PyBulletClient.remove_collision_mesh(*args, **kwargs)[source]
+PyBulletClient.remove_collision_mesh(*args, **kwargs)[source]
Forwards call to appropriate method in the planner.
diff --git a/latest/api/generated/compas_fab.backends.PyBulletClient.reset_planning_scene.html b/latest/api/generated/compas_fab.backends.PyBulletClient.reset_planning_scene.html
index 6cab49126..abf6a35ad 100644
--- a/latest/api/generated/compas_fab.backends.PyBulletClient.reset_planning_scene.html
+++ b/latest/api/generated/compas_fab.backends.PyBulletClient.reset_planning_scene.html
@@ -623,7 +623,7 @@
PyBulletClient.reset_planning_scene
-
-PyBulletClient.reset_planning_scene(*args, **kwargs)[source]
+PyBulletClient.reset_planning_scene(*args, **kwargs)[source]
Forwards call to appropriate method in the planner.
diff --git a/latest/api/generated/compas_fab.backends.PyBulletClient.set_robot_configuration.html b/latest/api/generated/compas_fab.backends.PyBulletClient.set_robot_configuration.html
index db0ed4622..7a8b51545 100644
--- a/latest/api/generated/compas_fab.backends.PyBulletClient.set_robot_configuration.html
+++ b/latest/api/generated/compas_fab.backends.PyBulletClient.set_robot_configuration.html
@@ -623,7 +623,7 @@
PyBulletClient.set_robot_configuration
-
-PyBulletClient.set_robot_configuration(robot, configuration, group=None)[source]
+PyBulletClient.set_robot_configuration(robot, configuration, group=None)[source]
Sets the robot’s pose to the given configuration. Should be followed by
step_simulation for visualization purposes.
diff --git a/latest/api/generated/compas_fab.backends.PyBulletClient.step_simulation.html b/latest/api/generated/compas_fab.backends.PyBulletClient.step_simulation.html
index c854d5f5f..a7510d90a 100644
--- a/latest/api/generated/compas_fab.backends.PyBulletClient.step_simulation.html
+++ b/latest/api/generated/compas_fab.backends.PyBulletClient.step_simulation.html
@@ -623,7 +623,7 @@
PyBulletClient.step_simulation
-
-PyBulletClient.step_simulation()[source]
+PyBulletClient.step_simulation()[source]
By default, the physics server will not step the simulation,
unless you explicitly send a step_simulation command. This
method will perform all the actions in a single forward dynamics
diff --git a/latest/api/generated/compas_fab.backends.PyBulletError.html b/latest/api/generated/compas_fab.backends.PyBulletError.html
index 338f058a3..7127f151d 100644
--- a/latest/api/generated/compas_fab.backends.PyBulletError.html
+++ b/latest/api/generated/compas_fab.backends.PyBulletError.html
@@ -623,7 +623,7 @@
PyBulletError
-
-exception compas_fab.backends.PyBulletError[source]
+exception compas_fab.backends.PyBulletError[source]
Bases: BackendError
Base case for exceptions in compas_fab.backends.pybullet.
diff --git a/latest/api/generated/compas_fab.backends.PyBulletPlanner.add_attached_collision_mesh.html b/latest/api/generated/compas_fab.backends.PyBulletPlanner.add_attached_collision_mesh.html
index c17c49def..3a28e8508 100644
--- a/latest/api/generated/compas_fab.backends.PyBulletPlanner.add_attached_collision_mesh.html
+++ b/latest/api/generated/compas_fab.backends.PyBulletPlanner.add_attached_collision_mesh.html
@@ -623,7 +623,7 @@
PyBulletPlanner.add_attached_collision_mesh
-
-PyBulletPlanner.add_attached_collision_mesh(attached_collision_mesh, options=None)[source]
+PyBulletPlanner.add_attached_collision_mesh(attached_collision_mesh, options=None)[source]
Add a collision mesh and attach it to the robot.
- Parameters:
diff --git a/latest/api/generated/compas_fab.backends.PyBulletPlanner.add_collision_mesh.html b/latest/api/generated/compas_fab.backends.PyBulletPlanner.add_collision_mesh.html
index fd69e91cc..783ff34bf 100644
--- a/latest/api/generated/compas_fab.backends.PyBulletPlanner.add_collision_mesh.html
+++ b/latest/api/generated/compas_fab.backends.PyBulletPlanner.add_collision_mesh.html
@@ -623,7 +623,7 @@
PyBulletPlanner.add_collision_mesh
-
-PyBulletPlanner.add_collision_mesh(collision_mesh, options=None)[source]
+PyBulletPlanner.add_collision_mesh(collision_mesh, options=None)[source]
Add a collision mesh to the planning scene.
- Parameters:
diff --git a/latest/api/generated/compas_fab.backends.PyBulletPlanner.append_collision_mesh.html b/latest/api/generated/compas_fab.backends.PyBulletPlanner.append_collision_mesh.html
index bb62f6387..1267bbded 100644
--- a/latest/api/generated/compas_fab.backends.PyBulletPlanner.append_collision_mesh.html
+++ b/latest/api/generated/compas_fab.backends.PyBulletPlanner.append_collision_mesh.html
@@ -623,7 +623,7 @@
PyBulletPlanner.append_collision_mesh
-
-PyBulletPlanner.append_collision_mesh(collision_mesh, options=None)[source]
+PyBulletPlanner.append_collision_mesh(collision_mesh, options=None)[source]
Append a collision mesh to the planning scene.
- Parameters:
diff --git a/latest/api/generated/compas_fab.backends.PyBulletPlanner.forward_kinematics.html b/latest/api/generated/compas_fab.backends.PyBulletPlanner.forward_kinematics.html
index 962933694..171c74b5c 100644
--- a/latest/api/generated/compas_fab.backends.PyBulletPlanner.forward_kinematics.html
+++ b/latest/api/generated/compas_fab.backends.PyBulletPlanner.forward_kinematics.html
@@ -623,7 +623,7 @@
PyBulletPlanner.forward_kinematics
-
-PyBulletPlanner.forward_kinematics(robot, configuration, group=None, options=None)[source]
+PyBulletPlanner.forward_kinematics(robot, configuration, group=None, options=None)[source]
Calculate the robot’s forward kinematic.
- Parameters:
diff --git a/latest/api/generated/compas_fab.backends.PyBulletPlanner.get_planning_scene.html b/latest/api/generated/compas_fab.backends.PyBulletPlanner.get_planning_scene.html
index c77e29df7..591a41569 100644
--- a/latest/api/generated/compas_fab.backends.PyBulletPlanner.get_planning_scene.html
+++ b/latest/api/generated/compas_fab.backends.PyBulletPlanner.get_planning_scene.html
@@ -623,7 +623,7 @@
PyBulletPlanner.get_planning_scene
-
-PyBulletPlanner.get_planning_scene(*args, **kwargs)[source]
+PyBulletPlanner.get_planning_scene(*args, **kwargs)[source]
Default method for planner.
- Raises:
diff --git a/latest/api/generated/compas_fab.backends.PyBulletPlanner.html b/latest/api/generated/compas_fab.backends.PyBulletPlanner.html
index db94a6d4d..8c73b56d4 100644
--- a/latest/api/generated/compas_fab.backends.PyBulletPlanner.html
+++ b/latest/api/generated/compas_fab.backends.PyBulletPlanner.html
@@ -623,7 +623,7 @@
PyBulletPlanner
-
-class compas_fab.backends.PyBulletPlanner[source]
+class compas_fab.backends.PyBulletPlanner[source]
Bases: PyBulletAddAttachedCollisionMesh, PyBulletAddCollisionMesh, PyBulletAppendCollisionMesh, PyBulletRemoveCollisionMesh, PyBulletRemoveAttachedCollisionMesh, PyBulletForwardKinematics, PyBulletInverseKinematics, PlannerInterface
Implement the planner backend interface for PyBullet.
Inherited Methods
diff --git a/latest/api/generated/compas_fab.backends.PyBulletPlanner.inverse_kinematics.html b/latest/api/generated/compas_fab.backends.PyBulletPlanner.inverse_kinematics.html
index f9856c71a..51c16856c 100644
--- a/latest/api/generated/compas_fab.backends.PyBulletPlanner.inverse_kinematics.html
+++ b/latest/api/generated/compas_fab.backends.PyBulletPlanner.inverse_kinematics.html
@@ -623,7 +623,7 @@
PyBulletPlanner.inverse_kinematics
-
-PyBulletPlanner.inverse_kinematics(robot, frame_WCF, start_configuration=None, group=None, options=None)[source]
+PyBulletPlanner.inverse_kinematics(robot, frame_WCF, start_configuration=None, group=None, options=None)[source]
Calculate the robot’s inverse kinematic for a given frame.
- Parameters:
diff --git a/latest/api/generated/compas_fab.backends.PyBulletPlanner.plan_cartesian_motion.html b/latest/api/generated/compas_fab.backends.PyBulletPlanner.plan_cartesian_motion.html
index 76d7ee8f8..0b94517b3 100644
--- a/latest/api/generated/compas_fab.backends.PyBulletPlanner.plan_cartesian_motion.html
+++ b/latest/api/generated/compas_fab.backends.PyBulletPlanner.plan_cartesian_motion.html
@@ -623,7 +623,7 @@
PyBulletPlanner.plan_cartesian_motion
-
-PyBulletPlanner.plan_cartesian_motion(*args, **kwargs)[source]
+PyBulletPlanner.plan_cartesian_motion(*args, **kwargs)[source]
Default method for planner.
- Raises:
diff --git a/latest/api/generated/compas_fab.backends.PyBulletPlanner.plan_motion.html b/latest/api/generated/compas_fab.backends.PyBulletPlanner.plan_motion.html
index 2c3a99059..0ffce4a15 100644
--- a/latest/api/generated/compas_fab.backends.PyBulletPlanner.plan_motion.html
+++ b/latest/api/generated/compas_fab.backends.PyBulletPlanner.plan_motion.html
@@ -623,7 +623,7 @@
PyBulletPlanner.plan_motion
-
-PyBulletPlanner.plan_motion(*args, **kwargs)[source]
+PyBulletPlanner.plan_motion(*args, **kwargs)[source]
Default method for planner.
- Raises:
diff --git a/latest/api/generated/compas_fab.backends.PyBulletPlanner.remove_attached_collision_mesh.html b/latest/api/generated/compas_fab.backends.PyBulletPlanner.remove_attached_collision_mesh.html
index deefd0476..50fea52db 100644
--- a/latest/api/generated/compas_fab.backends.PyBulletPlanner.remove_attached_collision_mesh.html
+++ b/latest/api/generated/compas_fab.backends.PyBulletPlanner.remove_attached_collision_mesh.html
@@ -623,7 +623,7 @@
PyBulletPlanner.remove_attached_collision_mesh
-
-PyBulletPlanner.remove_attached_collision_mesh(id, options=None)[source]
+PyBulletPlanner.remove_attached_collision_mesh(id, options=None)[source]
Remove an attached collision mesh from the robot.
- Parameters:
diff --git a/latest/api/generated/compas_fab.backends.PyBulletPlanner.remove_collision_mesh.html b/latest/api/generated/compas_fab.backends.PyBulletPlanner.remove_collision_mesh.html
index 0ee75bec5..8d265d290 100644
--- a/latest/api/generated/compas_fab.backends.PyBulletPlanner.remove_collision_mesh.html
+++ b/latest/api/generated/compas_fab.backends.PyBulletPlanner.remove_collision_mesh.html
@@ -623,7 +623,7 @@
PyBulletPlanner.remove_collision_mesh
-
-PyBulletPlanner.remove_collision_mesh(id, options=None)[source]
+PyBulletPlanner.remove_collision_mesh(id, options=None)[source]
Remove a collision mesh from the planning scene.
- Parameters:
diff --git a/latest/api/generated/compas_fab.backends.PyBulletPlanner.reset_planning_scene.html b/latest/api/generated/compas_fab.backends.PyBulletPlanner.reset_planning_scene.html
index fff04c44c..3e96cecf6 100644
--- a/latest/api/generated/compas_fab.backends.PyBulletPlanner.reset_planning_scene.html
+++ b/latest/api/generated/compas_fab.backends.PyBulletPlanner.reset_planning_scene.html
@@ -623,7 +623,7 @@
PyBulletPlanner.reset_planning_scene
-
-PyBulletPlanner.reset_planning_scene(*args, **kwargs)[source]
+PyBulletPlanner.reset_planning_scene(*args, **kwargs)[source]
Default method for planner.
- Raises:
diff --git a/latest/api/generated/compas_fab.backends.RosClient.add_attached_collision_mesh.html b/latest/api/generated/compas_fab.backends.RosClient.add_attached_collision_mesh.html
index c6a8863b0..72a843cf5 100644
--- a/latest/api/generated/compas_fab.backends.RosClient.add_attached_collision_mesh.html
+++ b/latest/api/generated/compas_fab.backends.RosClient.add_attached_collision_mesh.html
@@ -623,7 +623,7 @@
RosClient.add_attached_collision_mesh
-
-RosClient.add_attached_collision_mesh(*args, **kwargs)[source]
+RosClient.add_attached_collision_mesh(*args, **kwargs)[source]
Forwards call to appropriate method in the planner.
diff --git a/latest/api/generated/compas_fab.backends.RosClient.add_collision_mesh.html b/latest/api/generated/compas_fab.backends.RosClient.add_collision_mesh.html
index 6781e5f33..0783446c2 100644
--- a/latest/api/generated/compas_fab.backends.RosClient.add_collision_mesh.html
+++ b/latest/api/generated/compas_fab.backends.RosClient.add_collision_mesh.html
@@ -623,7 +623,7 @@
RosClient.add_collision_mesh
-
-RosClient.add_collision_mesh(*args, **kwargs)[source]
+RosClient.add_collision_mesh(*args, **kwargs)[source]
Forwards call to appropriate method in the planner.
diff --git a/latest/api/generated/compas_fab.backends.RosClient.append_collision_mesh.html b/latest/api/generated/compas_fab.backends.RosClient.append_collision_mesh.html
index fc1575254..eb52238c7 100644
--- a/latest/api/generated/compas_fab.backends.RosClient.append_collision_mesh.html
+++ b/latest/api/generated/compas_fab.backends.RosClient.append_collision_mesh.html
@@ -623,7 +623,7 @@
RosClient.append_collision_mesh
-
-RosClient.append_collision_mesh(*args, **kwargs)[source]
+RosClient.append_collision_mesh(*args, **kwargs)[source]
Forwards call to appropriate method in the planner.
diff --git a/latest/api/generated/compas_fab.backends.RosClient.authenticate.html b/latest/api/generated/compas_fab.backends.RosClient.authenticate.html
index 4c7909949..a79ae261b 100644
--- a/latest/api/generated/compas_fab.backends.RosClient.authenticate.html
+++ b/latest/api/generated/compas_fab.backends.RosClient.authenticate.html
@@ -623,7 +623,7 @@
RosClient.authenticate
-
-RosClient.authenticate(mac, client, dest, rand, t, level, end)[source]
+RosClient.authenticate(mac, client, dest, rand, t, level, end)[source]
Sends an authorization request to the server.
- Note:
Sends authentication on connection.
diff --git a/latest/api/generated/compas_fab.backends.RosClient.blocking_call_from_thread.html b/latest/api/generated/compas_fab.backends.RosClient.blocking_call_from_thread.html
index b62d2ed04..bd24b106c 100644
--- a/latest/api/generated/compas_fab.backends.RosClient.blocking_call_from_thread.html
+++ b/latest/api/generated/compas_fab.backends.RosClient.blocking_call_from_thread.html
@@ -623,7 +623,7 @@
RosClient.blocking_call_from_thread
-
-RosClient.blocking_call_from_thread(callback, timeout)[source]
+RosClient.blocking_call_from_thread(callback, timeout)[source]
Call the given function from a thread, and wait for the result synchronously
for as long as the timeout will allow.
diff --git a/latest/api/generated/compas_fab.backends.RosClient.call_async_service.html b/latest/api/generated/compas_fab.backends.RosClient.call_async_service.html
index bb0972366..b0967a1dc 100644
--- a/latest/api/generated/compas_fab.backends.RosClient.call_async_service.html
+++ b/latest/api/generated/compas_fab.backends.RosClient.call_async_service.html
@@ -623,7 +623,7 @@
RosClient.call_async_service
-
-RosClient.call_async_service(message, callback, errback)[source]
+RosClient.call_async_service(message, callback, errback)[source]
Send a service request to ROS once the connection is established.
If a connection to ROS is already available, the request is sent immediately.
diff --git a/latest/api/generated/compas_fab.backends.RosClient.call_in_thread.html b/latest/api/generated/compas_fab.backends.RosClient.call_in_thread.html
index afad7035a..6cf0bebe9 100644
--- a/latest/api/generated/compas_fab.backends.RosClient.call_in_thread.html
+++ b/latest/api/generated/compas_fab.backends.RosClient.call_in_thread.html
@@ -623,7 +623,7 @@
RosClient.call_in_thread
-
-RosClient.call_in_thread(callback)[source]
+RosClient.call_in_thread(callback)[source]
Call the given function in a thread.
The threading implementation is deferred to the factory.
diff --git a/latest/api/generated/compas_fab.backends.RosClient.call_later.html b/latest/api/generated/compas_fab.backends.RosClient.call_later.html
index 5eb7f5136..4fd184ef3 100644
--- a/latest/api/generated/compas_fab.backends.RosClient.call_later.html
+++ b/latest/api/generated/compas_fab.backends.RosClient.call_later.html
@@ -623,7 +623,7 @@
RosClient.call_later
-
-RosClient.call_later(delay, callback)[source]
+RosClient.call_later(delay, callback)[source]
Call the given function after a certain period of time has passed.
- Args:
delay (int): Number of seconds to wait before invoking the callback.
diff --git a/latest/api/generated/compas_fab.backends.RosClient.call_sync_service.html b/latest/api/generated/compas_fab.backends.RosClient.call_sync_service.html
index 29a5cc73c..ee6b3726a 100644
--- a/latest/api/generated/compas_fab.backends.RosClient.call_sync_service.html
+++ b/latest/api/generated/compas_fab.backends.RosClient.call_sync_service.html
@@ -623,7 +623,7 @@
RosClient.call_sync_service
-
-RosClient.call_sync_service(message, timeout)[source]
+RosClient.call_sync_service(message, timeout)[source]
Send a blocking service request to ROS once the connection is established,
waiting for the result to be return.
If a connection to ROS is already available, the request is sent immediately.
diff --git a/latest/api/generated/compas_fab.backends.RosClient.close.html b/latest/api/generated/compas_fab.backends.RosClient.close.html
index d1d2169dd..8530e8447 100644
--- a/latest/api/generated/compas_fab.backends.RosClient.close.html
+++ b/latest/api/generated/compas_fab.backends.RosClient.close.html
@@ -623,7 +623,7 @@
RosClient.close
-
-RosClient.close(timeout=10)[source]
+RosClient.close(timeout=10)[source]
Disconnect from ROS.
diff --git a/latest/api/generated/compas_fab.backends.RosClient.connect.html b/latest/api/generated/compas_fab.backends.RosClient.connect.html
index 8b2b20a70..b2e6cb066 100644
--- a/latest/api/generated/compas_fab.backends.RosClient.connect.html
+++ b/latest/api/generated/compas_fab.backends.RosClient.connect.html
@@ -623,7 +623,7 @@
RosClient.connect
-
-RosClient.connect()[source]
+RosClient.connect()[source]
Connect to ROS.
diff --git a/latest/api/generated/compas_fab.backends.RosClient.delete_param.html b/latest/api/generated/compas_fab.backends.RosClient.delete_param.html
index 30361c8ce..6932bb1eb 100644
--- a/latest/api/generated/compas_fab.backends.RosClient.delete_param.html
+++ b/latest/api/generated/compas_fab.backends.RosClient.delete_param.html
@@ -623,7 +623,7 @@
RosClient.delete_param
-
-RosClient.delete_param(name, callback=None, errback=None)[source]
+RosClient.delete_param(name, callback=None, errback=None)[source]
Delete parameter from the ROS Parameter Server.
- Note:
To make this a blocking call, pass None to the callback parameter .
diff --git a/latest/api/generated/compas_fab.backends.RosClient.emit.html b/latest/api/generated/compas_fab.backends.RosClient.emit.html
index 178d9519c..16728a1e7 100644
--- a/latest/api/generated/compas_fab.backends.RosClient.emit.html
+++ b/latest/api/generated/compas_fab.backends.RosClient.emit.html
@@ -623,7 +623,7 @@
RosClient.emit
-
-RosClient.emit(event_name, *args)[source]
+RosClient.emit(event_name, *args)[source]
Trigger a named event.
diff --git a/latest/api/generated/compas_fab.backends.RosClient.execute_joint_trajectory.html b/latest/api/generated/compas_fab.backends.RosClient.execute_joint_trajectory.html
index e90b294da..7716a2574 100644
--- a/latest/api/generated/compas_fab.backends.RosClient.execute_joint_trajectory.html
+++ b/latest/api/generated/compas_fab.backends.RosClient.execute_joint_trajectory.html
@@ -623,7 +623,7 @@
RosClient.execute_joint_trajectory
-
-RosClient.execute_joint_trajectory(joint_trajectory, action_name='/execute_trajectory', callback=None, errback=None, feedback_callback=None, timeout=60000)[source]
+RosClient.execute_joint_trajectory(joint_trajectory, action_name='/execute_trajectory', callback=None, errback=None, feedback_callback=None, timeout=60000)[source]
Execute a joint trajectory via the MoveIt infrastructure.
- Parameters:
diff --git a/latest/api/generated/compas_fab.backends.RosClient.follow_configurations.html b/latest/api/generated/compas_fab.backends.RosClient.follow_configurations.html
index d39c9542c..aa2eceafa 100644
--- a/latest/api/generated/compas_fab.backends.RosClient.follow_configurations.html
+++ b/latest/api/generated/compas_fab.backends.RosClient.follow_configurations.html
@@ -623,7 +623,7 @@
RosClient.follow_configurations
-
-RosClient.follow_configurations(callback, joint_names, configurations, timesteps, timeout=60000)[source]
+RosClient.follow_configurations(callback, joint_names, configurations, timesteps, timeout=60000)[source]
diff --git a/latest/api/generated/compas_fab.backends.RosClient.follow_joint_trajectory.html b/latest/api/generated/compas_fab.backends.RosClient.follow_joint_trajectory.html
index 76d07adee..69e6af462 100644
--- a/latest/api/generated/compas_fab.backends.RosClient.follow_joint_trajectory.html
+++ b/latest/api/generated/compas_fab.backends.RosClient.follow_joint_trajectory.html
@@ -623,7 +623,7 @@
RosClient.follow_joint_trajectory
-
-RosClient.follow_joint_trajectory(joint_trajectory, action_name='/joint_trajectory_action', callback=None, errback=None, feedback_callback=None, timeout=60000)[source]
+RosClient.follow_joint_trajectory(joint_trajectory, action_name='/joint_trajectory_action', callback=None, errback=None, feedback_callback=None, timeout=60000)[source]
Follow the joint trajectory as computed by MoveIt planner.
- Parameters:
diff --git a/latest/api/generated/compas_fab.backends.RosClient.forward_kinematics.html b/latest/api/generated/compas_fab.backends.RosClient.forward_kinematics.html
index 5d3097c6f..54e62e850 100644
--- a/latest/api/generated/compas_fab.backends.RosClient.forward_kinematics.html
+++ b/latest/api/generated/compas_fab.backends.RosClient.forward_kinematics.html
@@ -623,7 +623,7 @@
RosClient.forward_kinematics
-
-RosClient.forward_kinematics(*args, **kwargs)[source]
+RosClient.forward_kinematics(*args, **kwargs)[source]
Forwards call to appropriate method in the planner.
diff --git a/latest/api/generated/compas_fab.backends.RosClient.get_action_servers.html b/latest/api/generated/compas_fab.backends.RosClient.get_action_servers.html
index 9a6a7ef9b..310608b6a 100644
--- a/latest/api/generated/compas_fab.backends.RosClient.get_action_servers.html
+++ b/latest/api/generated/compas_fab.backends.RosClient.get_action_servers.html
@@ -623,7 +623,7 @@
RosClient.get_action_servers
-
-RosClient.get_action_servers(callback, errback=None)[source]
+RosClient.get_action_servers(callback, errback=None)[source]
Retrieve list of action servers in ROS.
diff --git a/latest/api/generated/compas_fab.backends.RosClient.get_configuration.html b/latest/api/generated/compas_fab.backends.RosClient.get_configuration.html
index 8818daca9..9201eebd3 100644
--- a/latest/api/generated/compas_fab.backends.RosClient.get_configuration.html
+++ b/latest/api/generated/compas_fab.backends.RosClient.get_configuration.html
@@ -623,7 +623,7 @@
RosClient.get_configuration
-
-RosClient.get_configuration()[source]
+RosClient.get_configuration()[source]
diff --git a/latest/api/generated/compas_fab.backends.RosClient.get_message_details.html b/latest/api/generated/compas_fab.backends.RosClient.get_message_details.html
index d045be331..49d6c9cb4 100644
--- a/latest/api/generated/compas_fab.backends.RosClient.get_message_details.html
+++ b/latest/api/generated/compas_fab.backends.RosClient.get_message_details.html
@@ -623,7 +623,7 @@
RosClient.get_message_details
-
-RosClient.get_message_details(message_type, callback=None, errback=None)[source]
+RosClient.get_message_details(message_type, callback=None, errback=None)[source]
Retrieve details of a message type in ROS.
- Note:
To make this a blocking call, pass None to the callback parameter .
diff --git a/latest/api/generated/compas_fab.backends.RosClient.get_node_details.html b/latest/api/generated/compas_fab.backends.RosClient.get_node_details.html
index ca31cef47..a7fa5d7fb 100644
--- a/latest/api/generated/compas_fab.backends.RosClient.get_node_details.html
+++ b/latest/api/generated/compas_fab.backends.RosClient.get_node_details.html
@@ -623,7 +623,7 @@
RosClient.get_node_details
-
-RosClient.get_node_details(node, callback=None, errback=None)[source]
+RosClient.get_node_details(node, callback=None, errback=None)[source]
Retrieve list subscribed topics, publishing topics and services of a specific node name.
- Note:
To make this a blocking call, pass None to the callback parameter .
diff --git a/latest/api/generated/compas_fab.backends.RosClient.get_nodes.html b/latest/api/generated/compas_fab.backends.RosClient.get_nodes.html
index aac89189d..a87ac0203 100644
--- a/latest/api/generated/compas_fab.backends.RosClient.get_nodes.html
+++ b/latest/api/generated/compas_fab.backends.RosClient.get_nodes.html
@@ -623,7 +623,7 @@
RosClient.get_nodes
-
-RosClient.get_nodes(callback=None, errback=None)[source]
+RosClient.get_nodes(callback=None, errback=None)[source]
Retrieve list of active node names in ROS.
- Note:
To make this a blocking call, pass None to the callback parameter .
diff --git a/latest/api/generated/compas_fab.backends.RosClient.get_param.html b/latest/api/generated/compas_fab.backends.RosClient.get_param.html
index c174db2f7..1b95170a9 100644
--- a/latest/api/generated/compas_fab.backends.RosClient.get_param.html
+++ b/latest/api/generated/compas_fab.backends.RosClient.get_param.html
@@ -623,7 +623,7 @@
RosClient.get_param
-
-RosClient.get_param(name, callback=None, errback=None)[source]
+RosClient.get_param(name, callback=None, errback=None)[source]
Get the value of a parameter from the ROS Parameter Server.
- Note:
To make this a blocking call, pass None to the callback parameter .
diff --git a/latest/api/generated/compas_fab.backends.RosClient.get_params.html b/latest/api/generated/compas_fab.backends.RosClient.get_params.html
index 4adc6cb50..27d16041b 100644
--- a/latest/api/generated/compas_fab.backends.RosClient.get_params.html
+++ b/latest/api/generated/compas_fab.backends.RosClient.get_params.html
@@ -623,7 +623,7 @@
RosClient.get_params
-
-RosClient.get_params(callback=None, errback=None)[source]
+RosClient.get_params(callback=None, errback=None)[source]
Retrieve list of param names from the ROS Parameter Server.
- Note:
To make this a blocking call, pass None to the callback parameter .
diff --git a/latest/api/generated/compas_fab.backends.RosClient.get_planning_scene.html b/latest/api/generated/compas_fab.backends.RosClient.get_planning_scene.html
index f5948bcc3..48a3a1a4e 100644
--- a/latest/api/generated/compas_fab.backends.RosClient.get_planning_scene.html
+++ b/latest/api/generated/compas_fab.backends.RosClient.get_planning_scene.html
@@ -623,7 +623,7 @@
RosClient.get_planning_scene
-
-