poulet_py.hardware.triggers package

class BaseTrigger(**data)

Bases: BaseModel, ABC

Abstract base class for trigger devices.

abstractmethod cleanup()

Cleanup trigger resources.

Return type:

None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

abstractmethod wait()

Wait for trigger event.

Return type:

bool

name: str

timeout: float | None

class GPIOTrigger(*, name: str = '', timeout: float | None = None, pin: int, pull_up: bool = False, edge: Literal['rising', 'falling', 'both'] = 'rising')

Bases: BaseTrigger

GPIO-based trigger using gpiozero.

__init__(**data)

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

cleanup()

Cleanup GPIO resources.

Return type:

None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(context, /)

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Return type:

None

Args:

self: The BaseModel instance. context: The context.

wait()

Wait for GPIO event.

Return type:

bool

pin: int

pull_up: bool

edge: Literal['rising', 'falling', 'both']

name: str

timeout: float | None

class KeyboardTrigger(**data)

Bases: BaseTrigger

Keyboard-based trigger (press Enter key).

cleanup()

No cleanup needed for keyboard.

Return type:

None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

wait()

Wait for keyboard input with optional timeout.

Return type:

bool

key: str

name: str

timeout: float | None

Submodules

• poulet_py.hardware.triggers.base module
  • BaseTrigger
    • BaseTrigger.name
    • BaseTrigger.timeout
    • BaseTrigger.wait()
    • BaseTrigger.cleanup()
    • BaseTrigger.model_config
• poulet_py.hardware.triggers.gpio module
  • GPIOTrigger
    • GPIOTrigger.pin
    • GPIOTrigger.pull_up
    • GPIOTrigger.edge
    • GPIOTrigger.__init__()
    • GPIOTrigger.wait()
    • GPIOTrigger.cleanup()
    • GPIOTrigger.model_config
    • GPIOTrigger.model_post_init()
    • GPIOTrigger.name
    • GPIOTrigger.timeout
• poulet_py.hardware.triggers.keyboard module
  • KeyboardTrigger
    • KeyboardTrigger.key
    • KeyboardTrigger.wait()
    • KeyboardTrigger.cleanup()
    • KeyboardTrigger.model_config
    • KeyboardTrigger.name
    • KeyboardTrigger.timeout