Skip to content

brian.settings

brian

set_volume 

def set_volume(percent: float) -> None

Set current volume

Arguments:

  • percent: Percentage of the maximum volume to apply. The value will be clipped to range 0% ~ 100%. The volume will not be set higher, than the one set in the settings in main menu.

get_current_volume 

def get_current_volume() -> float

Returns:

Current speaker volume in percent (0% ~ 100%).

get_preferred_volume 

def get_preferred_volume() -> float

Returns:

Speaker volume that was set in the settings in main menu (0% ~ 100%).

set_lcd_brightness 

def set_lcd_brightness(percent: float) -> None

Set current lcd brightness

Arguments:

  • percent: Percentage of the maximum brightness to apply. The value will be clipped to range 1% ~ 100%. The brightness will not be set higher, than the one set in the settings in main menu.

get_current_lcd_brightness 

def get_current_lcd_brightness() -> float

Returns:

Current lcd brightness in percent (1% ~ 100%).

get_preferred_lcd_brightness 

def get_preferred_lcd_brightness() -> float

Returns:

Lcd brightness value that was set in the settings in main menu (0% ~ 100%).

enable_os_button_sounds 

def enable_os_button_sounds(enable: bool) -> None

Arguments:

  • enable: Whether to enable or disable os click sounds. Works only if OS is not muted in the settings in main menu.

are_os_button_sounds_enabled 

def are_os_button_sounds_enabled() -> bool

Returns:

Whether os clicks are enabled (not muted).

are_os_button_sounds_preferred 

def are_os_button_sounds_preferred() -> bool

Returns:

Whether os clicks were enabled in the settings in main menu.

enable_turn_off_by_buttons 

def enable_turn_off_by_buttons(enabled: bool) -> None

If enabled (default), first press of any left together with any right button will send a KeyboardInterrupt.

The second such press will hard abort the program. If disabled, the buttons will not be watched and the program can use them fully according to the programmer's needs. It is the programmer's responsibility to provide alternative shutdown mechanism. If no such mechanism is provided, the only two ways to exit a stuck program is to either eject the sd card or force power off of the entire brick.

Arguments:

  • enabled: true if the Brian should watch for the turn-off button pattern, false to ignore it.

enable_console_scroll 

def enable_console_scroll(enabled: bool) -> None

If enabled (default), turning the knob scrolls the program console on screen.

If disabled, the knob is left fully to the program. Console is autoscrolled to the end.

Arguments:

  • enabled: Whether knob rotation should scroll the console.