Configure your experience based on the task you want to complete.

class experience_recorder.configuration.configuration.Configuration(global_configuration)

Utility class to manage the configuration of the Experience Recorder, allowing the creation and loading of configuration files. In this class the following is configured:

Number of senses to use

Name of the senses

Type of senses

Ability of the senses

Parameters:: global_configuration (dict or None) – Previously created and loaded .yaml file or empty to start a new configuration.

ask_for_coordinates()

Ask for coordinates using input prompts to user.

Returns:: location – Screen coordinates.
Return type:: List(int,int,int,int)

ask_for_keyboard_usage()

This configuration allows keyboard to be tracked.

Returns:: keyboard_usage
Return type:: Boolean

ask_for_mouse_usage()

This configuration allows mouse to be tracked.

Returns:: mouse_usage
Return type:: Boolean

ask_for_sense(index)

ask for name, kind, skill and screen coordinates for the current sense.

Parameters:

index (int) – sense index

Returns:

name (str) – name identifier of the sense.
kind (int) – type of sense.
skill (int) – skill/processment configuration after perceiving the state.
location (List(int,int,int,int)) – Screen coordinates if sense’s kind is see.

ask_for_sense_amount()

ask for amount of senses for task configuration

Returns:: amount – Amount of senses inserted via prompt by the user.
Return type:: int

create()

Method to initiate the creation of a new configuration.

Returns:: conf – task configuration
Return type:: dict

load_configuration(dir)

Search for a task configuration file at directory and opens it.

Parameters:: dir (str) – task configuration directory.
Returns:: conf – Task configuration.
Return type:: dict

new_sense(kind, skill, location)

structure sense information into dict format.

Parameters:

kind (int) – type of sense.
skill (int) – skill/processment configuration after perceiving the state.
location (List(int,int,int,int)) – Screen coordinates if sense’s kind is see.

Returns:

sense – a dict containing all sense’s properties.

Return type:

dict

save_configuration(): Save task configuration inside tasks folder using current name.