Settings

class Settings(main_settings, corridor_settings, sound_settings, alarm_settings, directory_settings, screen_settings, touchscreen_settings, telegram_settings, bpod_settings, camera_settings, motor_settings, extra_settings)

Bases: object

The settings of the system. They are grouped in different categories.

__init__(main_settings, corridor_settings, sound_settings, alarm_settings, directory_settings, screen_settings, touchscreen_settings, telegram_settings, bpod_settings, camera_settings, motor_settings, extra_settings)

Methods

__init__(main_settings, corridor_settings, ...)
create_factory_settings()
create_factory_settings_if_first_launch()
get(key)	Get the value of a setting.
get_description(key)	Get the description of a setting.
get_index(key)	Get the index of the value of a setting when it is a enum or list of enums
get_indices(key)	Get the index of the value of a setting when it is a enum or list of enums
get_text(key)	Get the string representation of the value of a setting.
get_type(key)	Get the type of a setting.
get_values(key)	Get the possible values of a setting when it is a enum or list of enums
print()
replace_extra_settings()
restore_factory_settings()
set(key, value)
sync()

get(key)

Get the value of a setting.

Return type:

Any

get_description(key)

Get the description of a setting.

Return type:

str

get_index(key)

Get the index of the value of a setting when it is a enum or list of enums

Return type:

int

get_indices(key)

Get the index of the value of a setting when it is a enum or list of enums

Return type:

list[int]

get_text(key)

Get the string representation of the value of a setting.

Return type:

str

get_type(key)

Get the type of a setting.

Return type:

type | None

get_values(key)

Get the possible values of a setting when it is a enum or list of enums

Return type:

list