Features
Behavior
This module contains the behavior-related features of the robot.
- class pymirokai.features.abilities.behavior.Behavior
Bases:
objectClass to handle behavior-related features of the robot.
- exit_arms_collision()
Exit current arms collision.
- Return type:
Dict[str,Any]- Returns:
Dict[str, Any] – The response from the REST API.
- async list_all_locations()
List all the currently known locations by the robot.
- Return type:
list[Location]- Returns:
Dict[str, Any] – The locations.
- set_obstacle_avoidance(enabled)
Activate or deactivate the obstacle avoidance feature.
- Parameters:
enabled (bool) – True to enable, False to disable.
- Return type:
Dict[str,Any]- Returns:
Dict[str, Any] – The response from the REST API.
Generic
This module contains the generic features of the robot.
- class pymirokai.features.abilities.generic.Generic
Bases:
objectClass to handle generic features of the robot.
- get_character_name()
Get the current character name.
- Return type:
Dict[str,Any]- Returns:
Dict[str, Any] – The response from the REST API.
- get_language()
Get the current language setting.
- Return type:
Dict[str,Any]- Returns:
Dict[str, Any] – The response from the REST API.
- get_publishers()
Get the list of available publishers.
- Return type:
Dict[str,Any]- Returns:
Dict[str, Any] – The list of available publishers.
Interaction
This module contains the interaction-related features of the robot.
- class pymirokai.features.abilities.interaction.Interaction
Bases:
objectClass to handle interaction-related features of the robot.
- async autonomous_planning_output()
Print the last autonomous planning result.
- Return type:
str- Returns:
str – The last autonomous planning result.
- is_making_noise()
Check if the robot is making noise.
- Return type:
Dict[str,Any]- Returns:
Dict[str, Any] – The response from the REST API.
- is_seeing_handle()
Check if the robot is seeing a handle.
- Return type:
Dict[str,Any]- Returns:
Dict[str, Any] – The response from the REST API.
- is_seeing_human()
Check if the robot is seeing a human.
- Return type:
Dict[str,Any]- Returns:
Dict[str, Any] – The response from the REST API.
- is_sleeping()
Check if the robot is sleeping.
- Return type:
Dict[str,Any]- Returns:
Dict[str, Any] – The response from the REST API.
- async pddl_domain()
Print the last autonomous planning result.
- Return type:
str- Returns:
str – The last autonomous planning result.
- async pddl_problem()
Print the last autonomous planning result.
- Return type:
str- Returns:
str – The last autonomous planning result.
- set_actions_by_voice(enabled)
Activate or deactivate the trigger by voice.
- Parameters:
enabled (bool) – True to enable, False to disable.
- Return type:
Dict[str,Any]- Returns:
Dict[str, Any] – The response from the REST API.
- set_sound_level(level)
Set the sound level of the robot.
- Parameters:
level (int) – The sound level (0-100).
- Return type:
Dict[str,Any]- Returns:
Dict[str, Any] – The response from the REST API.
Runes
This module contains the runes features of the robot.
- class pymirokai.features.abilities.runes.Runes
Bases:
objectClass to handle generic features of the robot.
- get_all_runes_details()
Get details on all detected runes: ID, RSSI, Angles (horizontal and vertical).
- Return type:
Dict[str,Any]- Returns:
Dict[str, Any] – The response from the REST API.
- get_clicked_runes()
Get a list of all clicked runes.
- Return type:
Dict[str,Any]- Returns:
Dict[str, Any] – The response from the REST API.
- get_detected_runes()
Get a list of all detected runes.
- Return type:
Dict[str,Any]- Returns:
Dict[str, Any] – The response from the REST API.
- get_double_clicked_runes()
Get a list of all double-clicked runes.
- Return type:
Dict[str,Any]- Returns:
Dict[str, Any] – The response from the REST API.
- get_long_pressed_runes()
Get a list of all long-pressed runes.
- Return type:
Dict[str,Any]- Returns:
Dict[str, Any] – The response from the REST API.
- get_rune_angle_of_arrival(rune_id)
Get the angle of arrival of a rune.
- Parameters:
rune_id (str) – The ID of the rune to check.
- Return type:
Dict[str,Any]- Returns:
Dict[str, Any] – The response from the REST API.
- get_rune_rssi(rune_id)
Get the RSSI of a rune.
- Parameters:
rune_id (str) – The ID of the rune to check.
- Return type:
Dict[str,Any]- Returns:
Dict[str, Any] – The response from the REST API.
- is_clicked(rune_id)
Check if a rune has been clicked.
- Parameters:
rune_id (str) – The ID of the rune to check.
- Return type:
Dict[str,Any]- Returns:
Dict[str, Any] – The response from the REST API.
- is_detected(rune_id)
Check if a rune has been detected.
- Parameters:
rune_id (str) – The ID of the rune to check.
- Return type:
Dict[str,Any]- Returns:
Dict[str, Any] – The response from the REST API.
- is_double_clicked(rune_id)
Check if a rune has been double-clicked.
- Parameters:
rune_id (str) – The ID of the rune to check.
- Return type:
Dict[str,Any]- Returns:
Dict[str, Any] – The response from the REST API.
- is_long_pressed(rune_id)
Check if a rune has been long-pressed.
- Parameters:
rune_id (str) – The ID of the rune to check.
- Return type:
Dict[str,Any]- Returns:
Dict[str, Any] – The response from the REST API.
- is_seeing(rune_id)
Check if the robot is seeing a specific rune.
- Parameters:
rune_id (str) – The ID of the rune to check.
- Return type:
Dict[str,Any]- Returns:
Dict[str, Any] – The response from the REST API.
- rune_association(rune_id, virtual_id='', label='', rune_class='')
Assign a properties to a rune based on its ID.
- Parameters:
rune_id (str) – The ID of the rune to update.
virtual_id (str) – the virtual_id to associate with the rune.
label (str) – the label to associate with the rune.
class (str) – the class to associate with the rune.
rune_class (str)
- Return type:
Dict[str,str]- Returns:
Dict[str, str] – The response from the REST API.