Adds the python tutorial for the bindings

Signed-off-by: Voldivh <[email protected]>
gazebosim · Oct 3, 2023 · da3094b · da3094b
1 parent b012e82
commit da3094b
Show file tree

Hide file tree

Showing 8 changed files with 393 additions and 9 deletions.
diff --git a/python/examples/publisher.py b/python/examples/publisher.py
@@ -15,7 +15,6 @@
 
 from gz.msgs10.stringmsg_pb2 import StringMsg
 from gz.msgs10.vector3d_pb2 import Vector3d
-from gz.transport13 import AdvertiseMessageOptions
 from gz.transport13 import Node
 
 import time
@@ -39,10 +38,11 @@ def main():
         while True:
           count += 1
           vector3d_msg.x = count
-          if not (pub_stringmsg.publish(stringmsg_msg) or pub_vector3d.publish(vector3d_msg)):
+          if not (pub_stringmsg.publish(stringmsg_msg)):
               break
-
           print("Publishing 'Hello' on topic [{}]".format(stringmsg_topic))
+          if not (pub_vector3d.publish(vector3d_msg)):
+              break
           print("Publishing a Vector3d on topic [{}]".format(vector3d_topic))
           time.sleep(0.1)
 

diff --git a/python/examples/subscriber.py b/python/examples/subscriber.py
@@ -15,7 +15,6 @@
 
 from gz.msgs10.stringmsg_pb2 import StringMsg
 from gz.msgs10.vector3d_pb2 import Vector3d
-from gz.transport13 import SubscribeOptions
 from gz.transport13 import Node
 
 import time

diff --git a/python/src/transport/_gz_transport_pybind11.cc b/python/src/transport/_gz_transport_pybind11.cc
@@ -186,7 +186,7 @@ PYBIND11_MODULE(BINDINGS_MODULE_NAME, m) {
 
     py::class_<TopicStatistics>(
       m, "TopicStatistics",
-      "This class encapsulates statistics for a single topic..")
+      "This class encapsulates statistics for a single topic.")
       .def(py::init<>());
 
     auto node = py::class_<Node>(m, "Node",

diff --git a/tutorials/01_intro.md b/tutorials/01_intro.md
@@ -20,5 +20,5 @@ combination of custom code and [ZeroMQ] (http://zeromq.org/).
 
 ## What programming language can I use with Gazebo Transport?
 
-C++ is the native implementation and so far the only way to use the library.
-We hope to offer different wrappers for the most popular languages in the future.
+C++ is the native implementation and the only language that have available all library features.
+Python implementation is a wrapper around C++ methods using pybind11. It does not support all features like C++, but, contains the main features such as publication, subscription and service request.
diff --git a/tutorials/05_services.md b/tutorials/05_services.md
@@ -1,6 +1,6 @@
 \page services Services
 
-Next Tutorial: \ref security
+Next Tutorial: \ref python
 Previous Tutorial: \ref messages
 
 ## Overview