misty2py-skills 1.0.0

A Python library of Misty II skills developed using Misty2py library

Misty2py-skills

Misty2py-skills is a Python 3 library of Misty II skills developed using Misty2py library.

Documentations

The package misty2py_skills contains:

• misty2py_skills.face_recognition module - a skill that greets people upon face detection with their name if known and prompts a face training session if their face (and therefore their name) is not known.

• misty2py_skills.hey_misty module - a skill of Misty reacting to the "Hey Misty" keyphrase. Note: due to internal works of Misty's API, Misty only reacts to the keyphrase once every runtime.

• misty2py_skills.remote_control module - a skill that lets you control Misty via a keyboard. Note: since Misty is not a remote control race car, the controllability and responsiveness is not on the level of the typical remotelly controlled devices.

• misty2py_skills.question_answering module - a skill that allows to have a trivial conversation with Misty.

• misty2py_skills.demonstrations sub-package which contains skills that demonstrate the workings of misty2py package but are not necessarily useful for a real world implementation as-is.

  • misty2py_skills.demonstrations.battery_printer module - a skill that prints Misty's battery status every 250 ms in the terminal for the duration specified as the second CLI argument in seconds (optional, defaults to 2 seconds). Demonstrates working with events in misty2py.
  • misty2py_skills.demonstrations.explore module - a skill that should theoretically perform SLAM mapping of an unknown room but due to misalignment of Misty's API documentation and the real underlying structures, mapping is not currently performed as it auto-stops after a few second from entering the SLAM mapping mode.

• misty2py_skills.essentials sub-package for relatively simple skills that can be used as building blocks or are otherwise helpful for developing real-life skills.

  • misty2py_skills.essentials.free_memory module - a skill that removes non-system audio, video, image and recording files from Misty's memory.
  • misty2py_skills.essentials.movement module - a module containing the class Movement which handles Misty's movement. Note: only driving is currently implemented.

• misty2py_skills.expressions sub-package for expressions (audio-visual characteristics of Misty). Currently contains these modules:

  • misty2py_skills.expressions.listening module - a simple expression that makes Misty appear to be listening.
  • misty2py_skills.expressions.angry module - a simple expression that makes Misty appear to be angry.

• misty2py_skills.utils sub-package of utility modules, including:

  • misty2py_skills.utils.template file - a template file for developing a skill with Misty2py.
  • misty2py_skills.utils.status module - contains the classes Status and ActionLog which can be used to track the execution state of a script.
  • misty2py_skills.utils.converse module - contains utility functions for speaking and printing data.
  • misty2py_skills.utils.utils module - contains other utility functions.

Running the skills

• copy the .env.example from the root directory of this repository into .env and replace the values of MISTY_IP_ADDRESS and PROJECT_DIR with appropriate values
• if running from the source, run commands pip install poetry and poetry install to get the dependencies
• if running speech recognition-related skills, follow the directions below

Running speech recognition-related skills

• set up an account at Wit.ai
• create a new app there; if you wish to run the skill misty2py_skills.question_answering, select the option Import From a Backup and use the file in accompanying_data in the root directory of this repository as a backup file
• go to the dashboard of the new app, select Settings under Management and get the Server Access Token
• replace the value of WIT_AI_KEY in your .env file with the Server Access Token

Planned future features

• docstrings
• refine the explore skill
• add troubleshooting instructions