User_App_Fibonacci_Action_Client

Fibonacci Action Client

Requirements
Launch the Action Server on ROS
Configure Action Client on Unity3D
The Code Explained

0. Requirements

This tutorial assumes that you have completed:

1. Launch the Action Server on ROS

Note: This section assumes that you have ROS installed on a machine accessible from Unity machine and have rosbridge_server installed in ROS. See our wiki page for installation guide
In order to get Unity to talk to ROS, fire up RosBridge WebSocket by running the following in terminal

$ roslaunch rosbridge_server rosbridge_websocket.launch

Then get Fibonacci action server from ROS tutorial "Writing a Simple Action Server using the Execute Callback" running by executing the following in a separate terminal window:

$ rosrun actionlib_tutorials fibonacci_server

User_App_Actionlib_RosServer

2. Configure Action Client on Unity3D

Create a new empty GameObject, name it as 'RosConnector'. This is where we will attach our RosConnector and UnityFibonacciActionClient components.
Action Name is the name of the action, set it to "fibonacci". Usually published and subscribed topics are named as 'action_name/goal', 'action_name/feedback', etc.
Fibonacci Order is the order of Fibonacci series defined as the goal for this particular action. Users set the goal, and clicks on Send Goal to activate the action server. Users can preempt the activated server by clicking on Cancel Goal.
Status, Feedback, and Result are the fields to inform users about the current state of action server, and updated via callback functions of subscribed topics to the action server.
Simply run the Unity3D application, and click on "Send Goal".

User_App_ROS_UnityActionClient_Inspector

3. The Code Explained

ActionClient.cs is an abstract class which can be implemented by providing the message types of the defined ROS action. Please see the example implementation FibonacciActionClient.cs to observe the message types used for Fibonacci action example.

public abstract class ActionClient<TAction, TActionGoal, TActionResult, TActionFeedback, TGoal, TResult, TFeedback>
        where TAction : Action<TActionGoal, TActionResult, TActionFeedback, TGoal, TResult, TFeedback>
        where TActionGoal : ActionGoal<TGoal>
        where TActionResult : ActionResult<TResult>
        where TActionFeedback : ActionFeedback<TFeedback>
        where TGoal : Message
        where TResult : Message
        where TFeedback : Message

ActionClient has generic callback functions for subscriptions to 'action_name/status', 'action_name/feedback', and 'action_name/result', in which application-specific handling functions are called.
In order to implement ActionClient, users only have to implement the handling functions, for example, OnResultReceived() function to process the result received from the action server.

// Implement by user to handle result.
protected abstract void OnResultReceived();
private void ResultCallback(TActionResult actionResult)
{
    action.action_result = actionResult;
    OnResultReceived();
}

FibonacciActionClient object can be instantiated either on Unity3D or in a console application.
For the use of action client implementation on Unity3D, please see UnityFibonacciActionClient.cs and the corresponding inspector editor script.

public class UnityFibonacciActionClient : MonoBehaviour
{
    private RosConnector rosConnector;
    public FibonacciActionClient fibonacciActionClient;

    public string actionName;
    public int fibonacciOrder = 20;
    public string status = "";
    public string feedback = "";
    public string result = "";

    private void Start()
    {
        rosConnector = GetComponent<RosConnector>();
        fibonacciActionClient = new FibonacciActionClient(actionName, rosConnector.RosSocket);
        fibonacciActionClient.Initialize();
    }

Note that this is a MonoBehaviour class. On Unity3D application start, FibonacciActionClient object is instantiated with an action name and a RosSocket.

private void Update()
{
    status   = fibonacciActionClient.GetStatusString();
    feedback = fibonacciActionClient.GetFeedbackString();
    result   = fibonacciActionClient.GetResultString();
}

On every Unity3D update step, we just call the getter functions of FibonacciActionClient object to update the fields on the inspector.

public void RegisterGoal()
{
    fibonacciActionClient.fibonacciOrder = fibonacciOrder;
}

RegisterGoal() binds the Fibonacci order from the Unity3D inspector to the FibonacciActionClient object.
For the use of action client implementation in a console application, please see FibonacciActionClientConsoleExample.cs.

Next tutorial: Fibonacci Action Server