add documentation

tidewise · Dec 6, 2019 · 2b2fa32 · 2b2fa32
1 parent 3e67a72
commit 2b2fa32
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/motors_weg_cvw300.orogen b/motors_weg_cvw300.orogen
@@ -47,8 +47,18 @@ task_context 'Task', subclasses: 'iodrivers_base::Task' do
     # setup (and know what you are doing)
     property 'modbus_interframe_delay', '/base/Time'
 
+    # Control limits
+    #
+    # You may only set the speed and effort fields. Setting any other field
+    # will fail on configure
+    #
+    # If set, min and max speeds need to be the opposite of each other. The
+    # controller does not support limiting them separately
     property 'limits', '/base/JointLimits'
 
+    # Input command
+    #
+    # Only set the speed field
     input_port 'cmd_in', '/base/commands/Joints'
 
     output_port 'joint_samples', '/base/samples/Joints'