Skip to content

Navigate


Follow User

  • Description: Follow a user.

  • Args:

    • user_name (str): The name of the user to follow.
  • Endpoint: /api/v1/dict/

  • Type of Argument: Dict

  • JSON Example:

    {
      "command": "skill",
      "value": {
        "name": "follow_user",
        "user_name": user_name
      }
    }
    

Go To Absolute

  • Description: Go to an absolute position.

  • Args:

    • coordinates (Coordinates): Coordinates for the absolute position.
  • Endpoint: /api/v1/dict/

  • Type of Argument: Dict

  • JSON Example:

    {
      "command": "skill",
      "value": {
        "name": "go_to_absolute",
        "coordinates": value
      }
    }
    

Go To Relative

  • Description: Go to a relative position.

  • Args:

    • coordinates (Coordinates): Coordinates for the relative position.
  • Endpoint: /api/v1/dict/

  • Type of Argument: Dict

  • JSON Example:

    {
      "command": "skill",
      "value": {
        "name": "go_to_relative",
        "coordinates": value
      }
    }
    

Go To Rune

  • Description: Go to a specific rune.

  • Args:

    • rune (Rune): The rune to go to.
  • Endpoint: /api/v1/dict/

  • Type of Argument: Dict

  • JSON Example:

    {
      "command": "skill",
      "value": {
        "name": "go_to_rune",
        "rune": value
      }
    }
    

Turn To Rune

  • Description: Turn specific rune and stop moving.

  • Args:

    • rune (Rune): The rune to turn to.
  • Endpoint: /api/v1/dict/

  • Type of Argument: Dict

  • JSON Example:

    {
      "command": "skill",
      "value": {
        "name": "turn_to_rune",
        "rune": value
      }
    }
    

Track Rune

  • Description: Track a rune.

  • Args:

    • rune (Rune): The rune to track.
  • Endpoint: /api/v1/dict/

  • Type of Argument: Dict

  • JSON Example:

    {
      "command": "skill",
      "value": {
        "name": "track_rune",
        "rune": value
      }
    }
    

Move Backward

  • Description: Move backward a certain distance.

  • Args:

    • distance_meters (float): The distance to move backward, in meters.
  • Endpoint: /api/v1/dict/

  • Type of Argument: Dict

  • JSON Example:

    {
      "command": "skill",
      "value": {
        "name": "move_backward",
        "distance_meters": distance_meters
      }
    }
    

Move Forward

  • Description: Move forward a certain distance.

  • Args:

    • distance_meters (float): The distance to move forward, in meters.
  • Endpoint: /api/v1/dict/

  • Type of Argument: Dict

  • JSON Example:

    {
      "command": "skill",
      "value": {
        "name": "move_forward",
        "distance_meters": distance_meters
      }
    }
    

Move Left Side

  • Description: Move left side a certain distance.

  • Args:

    • distance_meters (float): The distance to move on the left side, in meters.
  • Endpoint: /api/v1/dict/

  • Type of Argument: Dict

  • JSON Example:

    {
      "command": "skill",
      "value": {
        "name": "move_left_side",
        "distance_meters": distance_meters
      }
    }
    

Move Right Side

  • Description: Move right side a certain distance.

  • Args:

    • distance_meters (float): The distance to move on the right side, in meters.
  • Endpoint: /api/v1/dict/

  • Type of Argument: Dict

  • JSON Example:

    {
      "command": "skill",
      "value": {
        "name": "move_right_side",
        "distance_meters": distance_meters
      }
    }
    

Stop Moving

  • Description: Stop the robot's movement.

  • Endpoint: /api/v1/dict/

  • Type of Argument: Dict

  • JSON Example:

    {
      "command": "skill",
      "value": {
        "name": "stop_moving"
      }
    }
    

Teleoperate

  • Description: Teleoperate the robot.

  • Args:

    • coordinates (Coordinates): Coordinates for teleoperation.
    • velocity (int): Speed of the robot. Default value is 1.
  • Endpoint: /api/v1/dict/

  • Type of Argument: Dict

  • JSON Example:

    {
      "command": "skill",
      "value": {
        "name": "teleoperate",
        "coordinates": value,
        "velocity": velocity
      }
    }
    

Turn Left

  • Description: Turn the robot to the left by a specified angle.

  • Args:

    • degrees (float): The angle in degrees to turn left.
    • Defaults to 90.0 degrees.
    • duration (timedelta): The duration of the turn. Negative values indicate automatic calculation.
    • Defaults to timedelta(seconds=-1.0).
  • Endpoint: /api/v1/dict/

  • Type of Argument: Dict

  • JSON Example:

    {
      "command": "skill",
      "value": {
        "name": "turn_left",
        "degrees": degrees,
        "duration": duration
      }
    }
    

Turn Right

  • Description: Turn the robot to the right by a specified angle.

  • Args:

    • degrees (float): The angle in degrees to turn right.
    • Defaults to 90.0 degrees.
    • duration (timedelta): The duration of the turn. Negative values indicate automatic calculation.
    • Defaults to timedelta(seconds=-1.0).
  • Endpoint: /api/v1/dict/

  • Type of Argument: Dict

  • JSON Example:

    {
      "command": "skill",
      "value": {
        "name": "turn_right",
        "degrees": degrees,
        "duration": duration
      }
    }
    

Turn Back

  • Description: Turn back the robot.

  • Endpoint: /api/v1/dict/

  • Type of Argument: Dict

  • JSON Example:

    {
      "command": "skill",
      "value": {
        "name": "turn_back"
      }
    }