UI Control¶

LedColor¶

class brian.uicontrol.LedColor(red: int, green: int, blue: int)

__init__(red: int, green: int, blue: int): Holds color definition for UI LEDs. Color values range from 0 to 255. When outside of this range, the values are clamped

red: int: Red component of the color, in range from 0 to 255. When set to a value outside of this range, the value is clamped

green: int: Green component of the color, in range from 0 to 255. When set to a value outside of this range, the value is clamped

blue: int: Blue component of the color, in range from 0 to 255. When set to a value outside of this range, the value is clamped

ButtonId¶

class brian.uicontrol.ButtonId(*values)

TOP_LEFT = 0

TOP_RIGHT = 1

BOTTOM_LEFT = 2

BOTTOM_RIGHT = 3

KNOB = 4

LedButtonAnimation¶

class brian.uicontrol.LedButtonAnimation(*values)

Constants for selecting behavior of button LEDs. Only in use when LED animations are handled by Brian OS.

OFF = 0: LED is fully off

STANDBY = 1: LED is pulsing at low brightness level

SELECTABLE = 2: LED is pulsing at medium brightness level

SELECTED = 3: LED is pulsing at high brightness level

inherit = 4: LED behavior is not set at this level; Behavior of a previous (system) level is used.

set button led¶

brian.uicontrol.set_button_led(target: ButtonId | Button | Knob, animation: LedButtonAnimation, color: LedColor = 'DEFAULT_COLOR_FROM_SETTINGS') → None

Set desired animation and color for a specific button (target). These settings override the animation requested by the PhysButtonOverlay and the default os button effect, unless LedButtonAnimation.inherit is used.

Parameters:

target – Target button to change color. When Using UiEventsListener.any_button and UiEventsListener.any_button_incl_knob, all respective buttons change color/animation.
animation – Target animation.
color – Target color. When unfilled default color from settings is used.

enable knob rotation animation¶

brian.uicontrol.enable_knob_rotation_animation(enabled: bool) → None

If enabled, OS automatically animates the LEDs under the knob when it rotates. The user program starts in the enabled state.

Parameters:: enabled – Whether to animate knob rotation.

UI Event Listener¶

KnobEvent¶

class brian.uicontrol.UiEventsListener.UiEventsListener.KnobEvent

turn_delta: int

turned_to: int

is_pressed: bool

just_pressed: bool

just_released: bool

ButtonEvent¶

class brian.uicontrol.UiEventsListener.UiEventsListener.ButtonEvent

is_pressed: bool

just_pressed: bool

just_released: bool

ButtonsEvent¶

class brian.uicontrol.UiEventsListener.UiEventsListener.ButtonsEvent

top_left: ButtonEvent

top_right: ButtonEvent

bottom_left: ButtonEvent

bottom_right: ButtonEvent

any_button: ButtonEvent

any_button_incl_knob: ButtonEvent

Button¶

class brian.uicontrol.UiEventsListener.UiEventsListener.Button

wait_for_press(timeout_ms: int = -1) → bool

Waits for next button press event. This function is blocking.

Parameters:

timeout_ms – Maximum number of milliseconds to wait. - If the timeout is negative, the function will wait indefinitely.

Return success:

True: If the desired button event was caught.
False: If the timeout ran out.

wait_for_press_and_release(timeout_ms: int = -1) → bool

Waits for next button press and release event. This function is blocking.

Parameters:

timeout_ms – Maximum number of milliseconds to wait. - If the timeout is negative, the function will wait indefinitely.

Return success:

True: If the desired button event was caught.
False: If the timeout ran out.

wait_for_release(timeout_ms: int = -1) → bool

Waits for next button release event. This function is blocking.

Parameters:

timeout_ms – Maximum number of milliseconds to wait. - If the timeout is negative, the function will wait indefinitely.

Return success:

True: If the desired button event was caught.
False: If the timeout ran out.

last_button_event: ButtonEvent

Knob¶

class brian.uicontrol.UiEventsListener.UiEventsListener.Knob

wait_for_any_turn(timeout_ms: int = -1) → bool

Waits for next any turn of the knob. This function is blocking.

Parameters:

timeout_ms – Maximum number of milliseconds to wait. - If the timeout is negative, the function will wait indefinitely.

Return success:

True: If the desired button event was caught.
False: If the timeout ran out.

wait_for_directional_turn(clockwise: bool, timeout_ms: int = -1) → bool

Waits for next directional turn of the knob. This function is blocking.

Parameters:

clockwise – Whether to wait for clockwise or counterclockwise turn.
timeout_ms – Maximum number of milliseconds to wait. - If the timeout is negative, the function will wait indefinitely.

Return success:

True: If the desired button event was caught.
False: If the timeout ran out.

last_button_event: KnobEvent