Skip to content

Interact


Acknowledge Engagement

  • Description: Acknowledge engagement with the robot.

  • Endpoint: /api/v1/dict/

  • Type of Argument: Dict

  • JSON Example:

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

Describe What You See

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

  • Args:

    • language (str | None): The language in which to describe the surroundings.
  • Endpoint: /api/v1/dict/

  • Type of Argument: Dict

  • JSON Example:

    {
      "command": "skill",
      "value": {
        "name": "describe_what_you_see",
        "language": language
      }
    }
    

Express Joy

  • Description: Express joy.

  • Endpoint: /api/v1/dict/

  • Type of Argument: Dict

  • JSON Example:

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

Kiss

  • Description: Perform a kiss action.

  • Endpoint: /api/v1/dict/

  • Type of Argument: Dict

  • JSON Example:

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

Soft Coo

  • Description: Produce a cooing sound.

  • Endpoint: /api/v1/dict/

  • 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/v1/dict/

  • Type of Argument: Dict

  • JSON Example:

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

Start Conversation

  • Description: Activate llm and enable the conversation.

  • Endpoint: /api/v1/dict/

  • Type of Argument: Dict

  • JSON Example:

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

Stop Conversation

  • Description: Deactivate llm and disable the conversation.

  • Endpoint: /api/v1/dict/

  • 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/v1/dict/

  • Type of Argument: Dict

  • JSON Example:

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

Silence

  • Description: Current full TTS queue.

  • Endpoint: /api/v1/dict/

  • Type of Argument: Dict

  • JSON Example:

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

High Five

  • Description: High five wiht user.

  • Args:

    • arm (Arm): The arm to use for the high five. If None, the robot will randomly choose an arm.
  • Endpoint: /api/v1/dict/

  • 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): The arm to use for waving. If None, the robot waves with both arms.
  • Endpoint: /api/v1/dict/

  • 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/v1/dict/

  • Type of Argument: Dict

  • JSON Example:

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

Checkup Ears

  • Description: Check mirokai ears.

  • Endpoint: /api/v1/dict/

  • Type of Argument: Dict

  • JSON Example:

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

Japanese Greeting

  • Description: Do a japanese greeting.

  • Endpoint: /api/v1/dict/

  • Type of Argument: Dict

  • JSON Example:

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

Happy Kiss

  • Description: Send a happy kiss.

  • Endpoint: /api/v1/dict/

  • Type of Argument: Dict

  • JSON Example:

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

Shy Kiss

  • Description: Send a shy kiss.

  • Endpoint: /api/v1/dict/

  • Type of Argument: Dict

  • JSON Example:

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

Shake Hand

  • Description: Shake hand.

  • Endpoint: /api/v1/dict/

  • Type of Argument: Dict

  • JSON Example:

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

Check Internet Connectivity

  • Description: Check current internet connectivity.

  • Endpoint: /api/v1/dict/

  • 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 | None): Target to point at, 2d coordinates in the form [x, y]
  • Endpoint: /api/v1/dict/

  • Type of Argument: Dict

  • JSON Example:

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