Skip to content

API Data Types Documentation

This section details the specific data types utilized by the API.

1. Coordinates

  • Data Type Description: Used to specify relative movement or positioning in a 3D space.
  • Structure: A JSON object containing four keys:
  • x (float): The X-coordinate (forward/backward).
  • y (float): The Y-coordinate (left/right).
  • z (float): The Z-coordinate (upward/downward). Z will always be equal to 0 for navigation.
  • theta (float): The angular rotation in radians.
  • velocity (float): The velocity to use with command. Default is 0.5.
  • Example Value: 
    {"x": 1.5, "y": -0.5, "z": 0.0, "theta": 3.14, "velocity": 0.5}

2. Float

  • Data Type Description: A floating-point number typically used for precision measurements such as settings or levels.
  • Structure: A single floating-point value.
  • Example Value: 
    0.8

3. String

  • Data Type Description: A sequence of characters used to represent textual data.
  • Structure: A single string value.
  • Example Value: 
    "wave"

4. Boolean

  • Data Type Description: A true or false value, used for toggling states or binary settings.
  • Structure: A true or false value, represented as a Boolean in JSON.
  • Example Value: 
    true

5. Dictionary

  • Data Type Description: A collection of key-value pairs, where each key is a unique identifier and the value is the data associated with that key.
  • Structure: A JSON object containing keys and values, which can be of various types.
  • Example Value: 
    {"name": "reac_intensity", "value": 0.8}

Each of these data types is integral to the operation of the API, allowing users to specify detailed parameters for various commands. When interacting with the API, it's essential to ensure that the data sent in requests matches these expected formats to ensure correct operation and avoid errors.

API Data Models Documentation

Rune

  • Description: Represents a rune.
  • Attributes:
    • id (str): The rune's virtual ID.

EnchantedObject

  • Description: Represents a rune symbolizing an object to grasp.
  • Attributes:
    • id (str): The object rune's virtual ID .

EnchantedLocation

  • Description: Represents a rune symbolizing a location.
  • Attributes:
    • id (str): The location rune's virtual ID .

DepositZone

  • Description: Represents a deposit zone.
  • Attributes:
    • id (str): The deposit zone rune's virtual ID .

EnchantedHuman

  • Description: Represents a rune symbolizing a human.
  • Attributes:
    • id (str): The human rune's virtual ID .

GraspSide

  • Values:
    • LEFT: "left"
    • RIGHT: "right"

Arm

  • Values:
    • LEFT: "left_arm"
    • RIGHT: "right_arm"

Hand

  • Values:
    • LEFT: "left_hand"
    • RIGHT: "right_hand"

Ear

  • Values:
    • LEFT: "left_ear"
    • RIGHT: "right_ear"