simROS2.actionClientTreatUInt8ArrayAsString
simROS2.actionServerActionAbort
simROS2.actionServerActionCanceled
simROS2.actionServerActionExecute
simROS2.actionServerActionIsActive
simROS2.actionServerActionIsCanceling
simROS2.actionServerActionIsExecuting
simROS2.actionServerActionSucceed
simROS2.actionServerPublishFeedback
simROS2.actionServerTreatUInt8ArrayAsString
simROS2.call
simROS2.cancelLastGoal
simROS2.clientTreatUInt8ArrayAsString
simROS2.createActionClient
Description
|
Create a action client. |
Lua synopsis |
string actionClientHandle=simROS2.createActionClient(string actionName, string actionType, string goalResponseCallback, string feedbackCallback, string resultCallback)
|
Lua parameters |
actionName (string): action name, e.g.: '/fibonacci'
actionType (string): action type, e.g.: 'example_interfaces/action/Fibonacci'
goalResponseCallback (string): the goal response callback, will be called with arguments (goal_id,accepted) where accepted is a boolean value
feedbackCallback (string): the feedback callback, will be called with arguments (goal_id,feedback) where feedback is a table representing the Feedback message of the action type
resultCallback (string): the result callback, will be called with arguments (goal_id,code,result) where code is a value from simROS2.action_result_code, and result is a table representing the Result message of the action type
|
Lua return values |
actionClientHandle (string): a handle to the ROS action client |
Python synopsis |
string actionClientHandle=simROS2.createActionClient(string actionName, string actionType, string goalResponseCallback, string feedbackCallback, string resultCallback)
|
See also
|
simROS2.actionClientTreatUInt8ArrayAsString simROS2.actionServerActionAbort simROS2.actionServerActionCanceled simROS2.actionServerActionExecute simROS2.actionServerActionIsActive simROS2.actionServerActionIsCanceling simROS2.actionServerActionIsExecuting simROS2.actionServerActionSucceed simROS2.actionServerPublishFeedback simROS2.actionServerTreatUInt8ArrayAsString simROS2.cancelLastGoal simROS2.createActionServer simROS2.createInterface simROS2.getInterfaceConstants simROS2.sendGoal simROS2.shutdownActionClient simROS2.shutdownActionServer simROS2.supportedInterfaces
|
simROS2.createActionServer
Description
|
Create an action server. |
Lua synopsis |
string actionServerHandle=simROS2.createActionServer(string actionName, string actionType, string handleGoalCallback, string handleCancelCallback, string handleAcceptedCallback)
|
Lua parameters |
actionName (string): action name, e.g.: '/fibonacci'
actionType (string): action type, e.g.: 'example_interfaces/action/Fibonacci'
handleGoalCallback (string): name of callback function, which will be called with arguments (goal_id, goal) where goal is a table representing the Goal message of the action type. the callback must return a valid simROS2.goal_response
handleCancelCallback (string): name of callback function, which will be called with arguments (goal_id, goal) where goal is a table representing the Goal message of the action type. the callback must return a valid simROS2.cancel_response
handleAcceptedCallback (string): name of callback function, which will be called with arguments (goal_id, goal) where goal is a table representing the Goal message of the action type. it will be called after the goal is accepted, and is responsible of executing the goal, but must return immediately.
|
Lua return values |
actionServerHandle (string): a handle to the action server |
Python synopsis |
string actionServerHandle=simROS2.createActionServer(string actionName, string actionType, string handleGoalCallback, string handleCancelCallback, string handleAcceptedCallback)
|
See also
|
simROS2.actionClientTreatUInt8ArrayAsString simROS2.actionServerActionAbort simROS2.actionServerActionCanceled simROS2.actionServerActionExecute simROS2.actionServerActionIsActive simROS2.actionServerActionIsCanceling simROS2.actionServerActionIsExecuting simROS2.actionServerActionSucceed simROS2.actionServerPublishFeedback simROS2.actionServerTreatUInt8ArrayAsString simROS2.cancelLastGoal simROS2.createActionClient simROS2.createInterface simROS2.getInterfaceConstants simROS2.sendGoal simROS2.shutdownActionClient simROS2.shutdownActionServer simROS2.supportedInterfaces
|
simROS2.createClient
simROS2.createInterface
simROS2.createPublisher
Description
|
Create a topic publisher. |
Lua synopsis |
string publisherHandle=simROS2.createPublisher(string topicName, string topicType, int queueSize=1, bool latch=false)
|
Lua parameters |
topicName (string): topic name, e.g.: '/cmd_vel'
topicType (string): topic type, e.g.: 'geometry_msgs/msg/Twist'
queueSize (int, default: 1): (optional) queue size
latch (bool, default: false): (optional) latch topic
|
Lua return values |
publisherHandle (string): a handle to the ROS publisher |
Python synopsis |
string publisherHandle=simROS2.createPublisher(string topicName, string topicType, int queueSize=1, bool latch=false)
|
See also
|
simROS2.createInterface simROS2.createSubscription simROS2.getInterfaceConstants simROS2.imageTransportCreatePublisher simROS2.imageTransportCreateSubscription simROS2.imageTransportPublish simROS2.imageTransportShutdownPublisher simROS2.imageTransportShutdownSubscription simROS2.publish simROS2.publisherTreatUInt8ArrayAsString simROS2.sendTransform simROS2.sendTransforms simROS2.shutdownPublisher simROS2.shutdownSubscription simROS2.subscriptionTreatUInt8ArrayAsString simROS2.supportedInterfaces
|
simROS2.createService
simROS2.createSubscription
Description
|
Create a subscription to a topic. |
Lua synopsis |
string subscriptionHandle=simROS2.createSubscription(string topicName, string topicType, string topicCallback, int queueSize=1)
|
Lua parameters |
topicName (string): topic name, e.g.: '/cmd_vel'
topicType (string): topic type, e.g.: 'geometry_msgs/msg/Twist'
topicCallback (string): name of the callback function, which will be called with a single argument of type table containing the message payload, e.g.: {linear={x=1.5, y=0.0, z=0.0}, angular={x=0.0, y=0.0, z=-2.3}}
queueSize (int, default: 1): (optional) queue size
|
Lua return values |
subscriptionHandle (string): a handle to the ROS subscription |
Python synopsis |
string subscriptionHandle=simROS2.createSubscription(string topicName, string topicType, string topicCallback, int queueSize=1)
|
See also
|
simROS2.createInterface simROS2.createPublisher simROS2.getInterfaceConstants simROS2.imageTransportCreatePublisher simROS2.imageTransportCreateSubscription simROS2.imageTransportPublish simROS2.imageTransportShutdownPublisher simROS2.imageTransportShutdownSubscription simROS2.publish simROS2.publisherTreatUInt8ArrayAsString simROS2.sendTransform simROS2.sendTransforms simROS2.shutdownPublisher simROS2.shutdownSubscription simROS2.subscriptionTreatUInt8ArrayAsString simROS2.supportedInterfaces
|
simROS2.deleteParam
simROS2.getInterfaceConstants
simROS2.getParamBool
simROS2.getParamDouble
simROS2.getParamInt
simROS2.getParamString
simROS2.getSimulationTime
Lua synopsis |
simROS2.getSimulationTime()
|
Lua parameters |
- |
Lua return values |
- |
Python synopsis |
simROS2.getSimulationTime()
|
See also
|
|
simROS2.getSystemTime
Lua synopsis |
simROS2.getSystemTime()
|
Lua parameters |
- |
Lua return values |
- |
Python synopsis |
simROS2.getSystemTime()
|
See also
|
|
simROS2.getTime
Description
|
Return the current time according to the specified clock. |
Lua synopsis |
sim_ros2_time time=simROS2.getTime(int clock_type=sim_ros2_clock_ros)
|
Lua parameters |
|
Lua return values |
time (sim_ros2_time): ROS time |
Python synopsis |
sim_ros2_time time=simROS2.getTime(int clock_type=sim_ros2_clock_ros)
|
See also
|
|
simROS2.hasParam
simROS2.imageTransportCreatePublisher
simROS2.imageTransportCreateSubscription
simROS2.imageTransportPublish
simROS2.imageTransportShutdownPublisher
simROS2.imageTransportShutdownSubscription
simROS2.importInterface
Lua synopsis |
simROS2.importInterface(string name)
|
Lua parameters |
name (string): the name of the interface to import, e.g.: geometry_msgs/msg/Vector3 |
Lua return values |
- |
Python synopsis |
simROS2.importInterface(string name)
|
See also
|
|
simROS2.publish
simROS2.publisherTreatUInt8ArrayAsString
simROS2.sendGoal
simROS2.sendTransform
Description
|
Publish a TF transformation between frames. |
Lua synopsis |
simROS2.sendTransform(table transform)
|
Lua parameters |
transform (table): the transformation expressed as a geometry_msgs/msg/TransformStamped message, i.e. {header={stamp=timeStamp, frame_id='...'}, child_frame_id='...', transform={translation={x=..., y=..., z=...}, rotation={x=..., y=..., z=..., w=...}}} |
Lua return values |
- |
Python synopsis |
simROS2.sendTransform(list transform)
|
See also
|
simROS2.createInterface simROS2.createPublisher simROS2.createSubscription simROS2.getInterfaceConstants simROS2.imageTransportCreatePublisher simROS2.imageTransportCreateSubscription simROS2.imageTransportPublish simROS2.imageTransportShutdownPublisher simROS2.imageTransportShutdownSubscription simROS2.publish simROS2.publisherTreatUInt8ArrayAsString simROS2.sendTransforms simROS2.shutdownPublisher simROS2.shutdownSubscription simROS2.subscriptionTreatUInt8ArrayAsString simROS2.supportedInterfaces simROS2.sendTransforms
|
simROS2.sendTransforms
simROS2.serviceTreatUInt8ArrayAsString
simROS2.setParamBool
simROS2.setParamDouble
simROS2.setParamInt
simROS2.setParamString
simROS2.shutdownActionClient
simROS2.shutdownActionServer
simROS2.shutdownClient
simROS2.shutdownPublisher
simROS2.shutdownService
simROS2.shutdownSubscription
simROS2.subscriptionTreatUInt8ArrayAsString
simROS2.supportedInterfaces
simROS2.timeFromFloat
Lua synopsis |
simROS2.timeFromFloat(float t)
|
Lua parameters |
t (float): the time as a floating point number |
Lua return values |
- |
Python synopsis |
simROS2.timeFromFloat(float t)
|
See also
|
|
simROS2.timeToFloat
Lua synopsis |
simROS2.timeToFloat(table t)
|
Lua parameters |
t (table): the time as a table with integer sec and nanosec fields |
Lua return values |
- |
Python synopsis |
simROS2.timeToFloat(list t)
|
See also
|
|
simROS2.waitForService
|