Interact

---

Start Engagement

• Description: Sequence of animation to show the robot starts interaction with a human.

• Args:

  • human (User): human to engage with.

• Endpoint: /api/v2/commands/skill/

• HTTP Method: POST

• Type of Argument: Dict

• JSON Example:

  {
    "command": "skill",
    "value": {
      "name": "start_engagement",
      "human": human
    }
  }
  

Stop Engagement

• Description: Sequence of animation to show the robot stops interaction with a human.

• Args:

  • human (User): human to disengage from.

• Endpoint: /api/v2/commands/skill/

• HTTP Method: POST

• Type of Argument: Dict

• JSON Example:

  {
    "command": "skill",
    "value": {
      "name": "stop_engagement",
      "human": human
    }
  }
  

Acknowledge Engagement

• Description: Acknowledge engagement with the robot.

• Endpoint: /api/v2/commands/skill/

• HTTP Method: POST

• Type of Argument: Dict

• JSON Example:

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

Analyze Vision

• Description: Describe the robot's surroundings by taking a picture. WARNING: This function uploads the picture to a cloud service for processing.

• Args:

  • specific_instruction (str | None): A specific element or aspect of the scene to analyze. If None, the robot will provide a general description of the scene. Defaults to None.

• Endpoint: /api/v2/commands/skill/

• HTTP Method: POST

• Type of Argument: Dict

• JSON Example:

  {
    "command": "skill",
    "value": {
      "name": "analyze_vision",
      "specific_instruction": specific_instruction
    }
  }
  

Express Joy

• Description: Express joy.

• Endpoint: /api/v2/commands/skill/

• HTTP Method: POST

• Type of Argument: Dict

• JSON Example:

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

Kiss

• Description: Perform a kiss action.

• Endpoint: /api/v2/commands/skill/

• HTTP Method: POST

• Type of Argument: Dict

• JSON Example:

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

Soft Coo

• Description: Produce a cooing sound.

• Endpoint: /api/v2/commands/skill/

• HTTP Method: POST

• Type of Argument: Dict

• JSON Example:

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

Say

• Description: Say something with emotion and autonomous reaction.

• Args:

  • something (str): The text to say.

• Endpoint: /api/v2/commands/skill/

• HTTP Method: POST

• Type of Argument: Dict

• JSON Example:

  {
    "command": "skill",
    "value": {
      "name": "say",
      "something": something
    }
  }
  

Start Conversation

• Description: Activate llm and enable the conversation.

• Endpoint: /api/v2/commands/skill/

• HTTP Method: POST

• Type of Argument: Dict

• JSON Example:

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

Stop Conversation

• Description: Deactivate llm and disable the conversation.

• Endpoint: /api/v2/commands/skill/

• HTTP Method: POST

• Type of Argument: Dict

• JSON Example:

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

Start Or Stop Conversation

• Description: Deactivate llm and disable the conversation or Activate llm and enable the conversation.

• Endpoint: /api/v2/commands/skill/

• HTTP Method: POST

• Type of Argument: Dict

• JSON Example:

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

Silence

• Description: Current full TTS queue.

• Endpoint: /api/v2/commands/skill/

• HTTP Method: POST

• Type of Argument: Dict

• JSON Example:

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

High Five

• Description: High five with user.

• Args:

  • arm (Arm | None): The arm to use for the high five. If None, the robot will randomly choose an arm. Defaults to None.

• Endpoint: /api/v2/commands/skill/

• HTTP Method: POST

• Type of Argument: Dict

• JSON Example:

  {
    "command": "skill",
    "value": {
      "name": "high_five",
      "arm": arm
    }
  }
  

Wave

• Description: Wave with a specified arm or both arms.

• Args:

  • arm (Arm | None): The arm to use for waving. If None, the robot waves with both arms. Defaults to None.

• Endpoint: /api/v2/commands/skill/

• HTTP Method: POST

• Type of Argument: Dict

• JSON Example:

  {
    "command": "skill",
    "value": {
      "name": "wave",
      "arm": arm
    }
  }
  

Start Or Stop Actions By Voice

• Description: Deactivate or activate actions by voice.

• Endpoint: /api/v2/commands/skill/

• HTTP Method: POST

• Type of Argument: Dict

• JSON Example:

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

Checkup Ears

• Description: Check mirokai ears.

• Endpoint: /api/v2/commands/skill/

• HTTP Method: POST

• Type of Argument: Dict

• JSON Example:

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

Japanese Greeting

• Description: Do a japanese greeting.

• Endpoint: /api/v2/commands/skill/

• HTTP Method: POST

• Type of Argument: Dict

• JSON Example:

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

Happy Kiss

• Description: Send a happy kiss.

• Endpoint: /api/v2/commands/skill/

• HTTP Method: POST

• Type of Argument: Dict

• JSON Example:

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

Shy Kiss

• Description: Send a shy kiss.

• Endpoint: /api/v2/commands/skill/

• HTTP Method: POST

• Type of Argument: Dict

• JSON Example:

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

Shake Hand

• Description: Shake hand.

• Endpoint: /api/v2/commands/skill/

• HTTP Method: POST

• Type of Argument: Dict

• JSON Example:

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

Look Around Long

• Description: Sequence of the robot looking around at different positions, like they are discovering a new place.

• Endpoint: /api/v2/commands/skill/

• HTTP Method: POST

• Type of Argument: Dict

• JSON Example:

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

Check Internet Connectivity

• Description: Check current internet connectivity.

• Endpoint: /api/v2/commands/skill/

• HTTP Method: POST

• Type of Argument: Dict

• JSON Example:

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

Point At 2D Camera Point

• Description: Point at a 2D camera point.

• Args:

  • point2d (list[float] | None): Target 2D pixel coordinates [x, y]. Defaults to [700, 700] when omitted. Defaults to None.

• Endpoint: /api/v2/commands/skill/

• HTTP Method: POST

• Type of Argument: Dict

• JSON Example:

  {
    "command": "skill",
    "value": {
      "name": "point_at_2d_camera_point",
      "point2d": point2d
    }
  }
  

Inform Employee About Guest Arrival

• Description: Inform the employee that the guest has an appointment.

• Args:

  • employee_name (str): the name of the employee to inform the guest arrived.
  • guest (User): the person visiting employee_name.

• Endpoint: /api/v2/commands/skill/

• HTTP Method: POST

• Type of Argument: Dict

• JSON Example:

  {
    "command": "skill",
    "value": {
      "name": "inform_employee_about_guest_arrival",
      "employee_name": employee_name,
      "user": user
    }
  }