Skip to content

Navigate

Distribute Something In Tray

  • Description: Distributes an item in a tray by navigating to different locations and showing the tray to detected users. The function performs two things steps: 1. Navigates to different locations and waits at each spot. 2. If a user is detected 2.1. We Cancel navigation 2.2. We Show the tray to users 2.3. We ask if he wants the item in the tray.

  • Args:

    • what_is_in_the_tray (str): What is in the tray.

  • Endpoint: /api/v1/dict/

  • Type of Argument: Dict

  • JSON Example: 

    {
  "command": "skill",
  "value": {
    "name": "distribute_something_in_tray",
    "what_is_in_the_tray": what_is_in_the_tray
  }
}

Follow User

  • Description: Follow a user.

  • Args:

    • rune (EnchantedUser): The rune of the user to follow.

  • Endpoint: /api/v1/dict/

  • Type of Argument: Dict

  • JSON Example: 

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

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": coordinates
  }
}

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": coordinates
  }
}

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": rune
  }
}

Go To Location

  • Description: Go to a specific location.

  • Args:

    • location (Location): The location to go to.

  • Endpoint: /api/v1/dict/

  • Type of Argument: Dict

  • JSON Example: 

    {
  "command": "skill",
  "value": {
    "name": "go_to_location",
    "location": location
  }
}

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": rune
  }
}

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": rune
  }
}

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: Enable or disable robot teleoperation.

  • Args:

    • enable (bool): Enable or disable teleoperation

  • Endpoint: /api/v1/dict/

  • Type of Argument: Dict

  • JSON Example: 

    {
  "command": "skill",
  "value": {
    "name": "teleoperate",
    "enable": enable
  }
}

Turn

  • Description: Turn the robot by a certain angle.

  • Args:

    • degrees (float): Angle in degrees (positive values only). Defaults to 90.0.
    • direction (Direction): Explicit direction override (Direction.LEFT or Direction.RIGHT).
    • duration (timedelta): Optional time (seconds) to complete the turn. If provided, it

  • Endpoint: /api/v1/dict/

  • Type of Argument: Dict

  • JSON Example: 

    {
  "command": "skill",
  "value": {
    "name": "turn",
    "degrees": degrees,
    "direction": direction,
    "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"
  }
}

Add New Location At Robot Position

  • Description: Add a new location in a persistent way where the robot is currently.

  • Args:

    • location_name (str): Name of the location to add.

  • Endpoint: /api/v1/dict/

  • Type of Argument: Dict

  • JSON Example: 

    {
  "command": "skill",
  "value": {
    "name": "add_new_location_at_robot_position",
    "location_name": location_name
  }
}

Get Current Location

  • Description: Get the robot's current location. Returns the current location if known.

  • Endpoint: /api/v1/dict/

  • Type of Argument: Dict

  • JSON Example: 

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