Contents:

• Getting Started
  • Overview
  • Table of Contents
  • Introduction
  • Key Methods
  • Robot Class Usage
  • Mission Management & Nesting
  • Custom Skills
  • Conclusion
• Creating Custom Skills in Pymirokai
  • How to Create a Custom Skill
  • Example: Fetch Rhymes Skill
  • Run skill_manager on your computer
  • Calling a Custom Skill
  • Auto-Start Skills
  • Final Notes
• Manage Skills in Pymirokai
  • Uploading a Skill
  • Removing a Skill
  • Listing Available Skills files
  • Enabling or Disabling a Skill
  • Summary of Skill Management Methods
• Background Missions
  • start_background_missions Skill
  • Default Background Skills
  • Customization
• Robot
  • BaseRobot
  • Robot
  • connect()
  • initialize_coloredlogs()
• Mission
  • Mission
  • MissionCancelledError
  • MissionError
  • serialize_kwargs()
  • serialize_timedelta()
  • start_loop()
• Decorators
  • accepts_priority()
  • ParameterDescription
  • skill()
• Features
  • Behavior
  • Generic
  • Interaction
  • Navigation
  • Runes
• Skills (User)
  • Animate
  • Freeze
  • Interact
  • Manipulate
  • Navigate
  • Show-Off
  • System
  • Transport
• Skills (Admin)
  • Animate
  • Freeze
  • Interact
  • Manipulate
  • Navigate
  • Show-Off
  • System
  • Transport
• Skills (Enchanter)
  • Animate
  • Freeze
  • Interact
  • Manipulate
  • Navigate
  • Show-Off
  • System
  • Transport
• Core Modules
  • RestAPI
  • WebSocketAPI
  • VideoAPI
  • VideoStreamManager
  • SkillsManager
• Enums
  • AccessLevel
  • Animation
  • ArmAnimations
  • BaseEmotion
  • InteractiveState
  • PostureState
  • Arm
  • Ear
  • GraspSide
  • HandMode
  • HeadMode
  • Side
  • EyesBehavior
  • SoundName
• Models
  • BoolCommand
  • Coordinates
  • DepositZone
  • DictCommand
  • EnchantedLocation
  • EnchantedObject
  • EnchantedUser
  • FloatCommand
  • IntCommand
  • ListCommand
  • Location
  • NoArgCommand
  • Rune
  • StrCommand
• Utils
  • make_async()
  • arm_to_arm_entity_identifier()
  • ear_to_ear_entity_identifier()
  • get_local_ip()
  • parse_json_recursively()
  • run_until_interruption()
  • serialize_data()
  • handle_cancel()
  • handle_run()
  • main()
  • run()
  • run_skills_manager()
  • send_auto_start_skills_list()
  • send_skills_list()
  • start_skills_manager()
  • SkillWrapper

Welcome to the Pymirokai Documentation !

Overview

This documentation provides a comprehensive guide to using the Pymirokai API, which is designed to facilitate communication and control of a robot through REST and WebSocket APIs. The API integrates various functionalities such as interaction, navigation, behavior control, grasping, and more.

Whether you are a developer looking to automate tasks or build sophisticated robotic applications, this API provides the necessary tools and interfaces.