Skip to content

Interaction Functions


Set Sound Level

  • Description: Sets the sound level using an integer value between 0 and 100.
  • Endpoint: /api/v1/int/
  • Type of Argument: Integer
  • JSON Example:
    {"command": "sound_level", "value": 50}
    

Trigger skill

  • Description: Trigger a specific skill or action for the robot to perform.
  • Endpoint: /api/v1/dict/
  • Type of Argument: Dict
  • JSON Example:
    {"command": "skill", "value": {"name": "wave"}
    
  • See skills list and their arguments in the skill pages.

Check If Sleeping

  • Description: Checks if the robot is sleeping.
  • Endpoint: /api/v1/get/
  • Type of Argument: None
  • JSON Example:
    {"command": "is_sleeping"}
    

Check If Seeing Human

  • Description: Checks if the robot is seeing a human.
  • Endpoint: /api/v1/get/
  • Type of Argument: None
  • JSON Example:
    {"command": "is_seeing_human"}
    

Check If Seeing Handle

  • Description: Checks if the robot is seeing a handle.
  • Endpoint: /api/v1/get/
  • Type of Argument: None
  • JSON Example:
    {"command": "is_seeing_handle"}
    

Get Speaking State

  • Description: Retrieves the current speaking state of the robot.
  • Endpoint: /api/v1/get/
  • Type of Argument: None
  • JSON Example:
    {"command": "get_speaking_state"}
    

Check If Making Noise

  • Description: Checks if the robot is making noise.
  • Endpoint: /api/v1/get/
  • Type of Argument: None
  • JSON Example:
    {"command": "is_making_noise"}