Enums

Define access levels controlling which users can trigger robot skills.

class pymirokai.enums.access_level.AccessLevel(value)

Bases: Enum

Access control levels for robot capabilities.

ENCHANTER

Full access, used internally for development or debugging.

ADMIN

Administrative access for system-level operations.

USER

Standard user access for common robot interactions.

ADMIN: int = 20

ENCHANTER: int = 10

USER: int = 30

Enumerations for robot animations, poses, and emotional states.

class pymirokai.enums.animation.Animation(value)

Bases: Enum

Expressive face animations and emotion-linked sequences.

These correspond to facial and head movement patterns used by the robot to express emotion or react to environmental and conversational cues.

AGREE_1 = 'agree_1'

AGREE_2 = 'agree_2'

ANGRY_SHOUT = 'angry_shout'

ASTONISHED = 'astonished'

BIG_LAUGH = 'big_laugh'

DANCE = 'dance'

DISAGREE = 'disagree'

DISAPPOINTED = 'disappointed'

EARS_DANCE = 'ears_dance'

EMBARRASSED_LAUGH = 'embarrassed_laugh'

FRIENDLY_SMILE = 'friendly_smile'

HAPPY_COOING = 'happy_cooing'

INTERROGATIVE_COOING = 'interrogative_cooing'

KISS = 'kiss'

LAUGH = 'laugh'

LOOK_AROUND = 'look_around'

MEOW = 'meow'

MIROKAI_SALUTATION = 'mirokai_salutation'

NEUTRAL_COOING = 'neutral_cooing'

OH_SOUND = 'oh_sound'

SMALL_LAUGH = 'small_laugh'

SPIN = 'spin'

SURPRISED_SHOUT = 'surprised_shout'

THUMBS_UP_BOTH = 'thumbs_up_both'

THUMB_UP = 'thumb_up'

TONGUE = 'tongue'

WAVE = 'wave'

WINK = 'wink'

WOUAW = 'wouaw'

YAWN = 'yawn'

class pymirokai.enums.animation.ArmAnimations(value)

Bases: Enum

Predefined arm movement poses and gestures.

CURL = 'CURL'

CURL_END = 'CURL_END'

CURL_OP = 'CURL_OP'

DANCE = 'DANCE'

EMBARASSED = 'EMBARASSED'

FREE_GRASP_POST_GRASP_VERTICAL = 'FREE_GRASP_POST_GRASP_VERTICAL'

GIVE_BASKET = 'GIVE_BASKET'

GIVE_HAND = 'GIVE_HAND'

GIVE_HAND_1 = 'GIVE_HAND_1'

GIVE_HAND_2 = 'GIVE_HAND_2'

GIVE_HAND_3 = 'GIVE_HAND_3'

GIVE_HAND_BACK = 'GIVE_HAND_BACK'

GIVE_HAND_NO_OPEN_HAND = 'GIVE_HAND_NO_OPEN_HAND'

GIVE_HAND_NO_OPEN_HAND_BACK = 'GIVE_HAND_NO_OPEN_HAND_BACK'

GIVE_HAND_NO_OPEN_HAND_FRONT = 'GIVE_HAND_NO_OPEN_HAND_FRONT'

GRASP_BUBBLE = 'GRASP_BUBBLE'

HAKA_0 = 'HAKA_0'

HAKA_1 = 'HAKA_1'

HAND_TRANSPORT_HIGH = 'HAND_TRANSPORT_HIGH'

LETS_DANCE_PALM_UP = 'LETS_DANCE_PALM_UP'

LIGHT_SPOT = 'LIGHT_SPOT'

LISTEN = 'LISTEN'

LOOK_AT_HAND_1 = 'LOOK_AT_HAND_1'

LOOK_AT_HAND_2 = 'LOOK_AT_HAND_2'

LOOK_AT_HAND_3 = 'LOOK_AT_HAND_3'

LOOK_AT_HAND_4 = 'LOOK_AT_HAND_4'

LOOK_AT_HAND_5 = 'LOOK_AT_HAND_5'

MOVE_BACKWARD = 'MOVE_BACKWARD'

MOVE_FORWARD = 'MOVE_FORWARD'

MOVE_FORWARD_FAST = 'MOVE_FORWARD_FAST'

MOVE_LEFT = 'MOVE_LEFT'

MOVE_RIGHT = 'MOVE_RIGHT'

POST_GRASP_BASKET = 'POST_GRASP_BASKET'

POST_GRASP_VERT = 'POST_GRASP_VERT'

PRE_GRASP_BASKET = 'PRE_GRASP_BASKET'

PRE_GRASP_VERT = 'PRE_GRASP_VERT'

SHOW_SOMETHING_UP_0 = 'SHOW_SOMETHING_UP_0'

SHOW_SOMETHING_UP_1 = 'SHOW_SOMETHING_UP_1'

SPIN_1 = 'SPIN_1'

SPIN_2 = 'SPIN_2'

TRAY_XZ_BACKWARD = 'TRAY_XZ_BACKWARD'

TRAY_XZ_FORWARD = 'TRAY_XZ_FORWARD'

UP_TRAY = 'UP_TRAY'

WAKE_UP_1 = 'WAKE_UP_1'

WAKE_UP_2 = 'WAKE_UP_2'

WAKE_UP_3 = 'WAKE_UP_3'

WAKE_UP_4 = 'WAKE_UP_4'

class pymirokai.enums.animation.BaseEmotion(value)

Bases: Enum

Base emotional states for the robot’s expressive behavior.

AMAZED_1 = 'amazed_1'

AMAZED_2 = 'amazed_2'

ANGRY = 'angry'

ARROGANT = 'arrogant'

CONFIDENT = 'confident'

CUTE = 'cute'

DAZZLED = 'dazzled'

DISGUSTED = 'disgusted'

EMBARRASSED = 'embarrassed'

EXCITED = 'excited'

GRUMPY = 'grumpy'

HAPPY = 'happy'

HESITANT = 'hesitant'

INTERESTED = 'interested'

JOYFUL = 'joyful'

NEUTRAL = 'neutral'

PROUD = 'proud'

SAD = 'sad'

SCARED_1 = 'scared_1'

SCARED_2 = 'scared_2'

SHOCKED = 'shocked'

THOUGHTFUL = 'thoughtful'

class pymirokai.enums.animation.InteractiveState(value)

Bases: Enum

Interactive robot states representing activity or engagement level.

ASLEEP = 'asleep'

ASLEEP_SLOW = 'asleep_slow'

DAB = 'dab'

IDLE = 'idle'

LISTENING = 'listening'

OOPSIE = 'oopsie'

TALKING = 'talking'

TALKING_LEFT_HAND = 'talking_left_hand'

TALKING_RIGHT_HAND = 'talking_right_hand'

TALKING_SAD = 'talking_sad'

WHISTLING = 'whistling'

class pymirokai.enums.animation.PostureState(value)

Bases: Enum

Postural configurations and full-body poses.

MOVING_FORWARD = 'moving_forward'

MOVING_FORWARD_FAST = 'moving_forward_fast'

PHOTO_POSE_BOTH_THUMBS_UP = 'photo_pose_both_thumbs_up'

PHOTO_POSE_HEART = 'photo_pose_heart'

PHOTO_POSE_THUMB_UP = 'photo_pose_thumb_up'

PHOTO_POSE_WINK = 'photo_pose_wink'

STANDARD_POSTURE = 'standard_posture'

Enumerations for robot body parts, sides, and mechanical modes.

class pymirokai.enums.body_parts.Arm(value)

Bases: Enum

Map robot arms to their corresponding side.

LEFT = Side.LEFT

RIGHT = Side.RIGHT

class pymirokai.enums.body_parts.Ear(value)

Bases: Enum

Alias enumeration for ear side (left/right).

LEFT = 'left'

RIGHT = 'right'

class pymirokai.enums.body_parts.GraspSide(value)

Bases: Enum

Alias enumeration for grasping side (left/right).

LEFT = 'left'

RIGHT = 'right'

class pymirokai.enums.body_parts.HandMode(value)

Bases: Enum

Define available hand modes (open/close/thumb up/down) for each side.

CLOSE_L = 'close_l'

CLOSE_R = 'close_r'

OPEN_L = 'open_l'

OPEN_R = 'open_r'

THUMB_DOWN_L = 'thumb_down_l'

THUMB_DOWN_R = 'thumb_down_r'

THUMB_UP_L = 'thumb_up_l'

THUMB_UP_R = 'thumb_up_r'

class pymirokai.enums.body_parts.HeadMode(value)

Bases: Enum

Define head control modes (animate, freeze, scan, track).

ANIMATE = 'animate'

FREEZE = 'freeze'

SCAN = 'scan'

TRACK = 'track'

class pymirokai.enums.body_parts.Side(value)

Bases: Enum

Enumerate left and right sides of the robot.

LEFT = 'left'

RIGHT = 'right'

Enumerations defining idle and attention behaviors of the robot’s eyes.

class pymirokai.enums.eyes_behavior.EyesBehavior(value)

Bases: Enum

Possible gaze patterns and idle animations for the robot’s eyes.

BROAD_LOOK_AWAY = 'broad_look_away'

EYE_WANDER = 'eye_wander'

IDLE = 'idle'

INFINITE_SHAPE = 'infinite_shape'

LOOK_DOWN = 'look_down'

LOOK_UP = 'look_up'

PIPED_RANDOM = 'piped_random'

STRAIGHT = 'straight'

Enumerations for sound expressions and vocal reactions of the robot.

class pymirokai.enums.sound.SoundName(value)

Bases: Enum

Sound identifiers for emotional or contextual vocal expressions.

AGREE_HUMHUM = 'agree_humhum'

ANGER_GROWL = 'anger_growl'

DISAGREEMENT_MEH = 'disagreement_meh'

FEAR_BREATH = 'fear_breath'

HAPPY_COOING = 'happy_cooing'

INTEREST_AH = 'interest_ah'

INTEREST_OH = 'interest_oh'

INTERROGATIVE_COOING = 'interrogative_cooing'

KISS = 'kiss'

MEOW = 'meow'

NEUTRAL_COOING = 'neutral_cooing'

OUHSI_OHOH = 'oupsi_ohoh'

PROUT = 'prout'

PURR = 'purr'

RELIEF_VOCAL = 'relief_vocal'

SADNESS_MOPE = 'sadness_mope'

SURPRISED_SHOUT = 'surprised_shout'

TCHIP = 'tchip'

WOUAW = 'wouaw'