Heater Mixin

This module contains the HeaterMixin class.

ATTRIBUTE	DESCRIPTION
`TOLERANCE`	tolerance for temperature TYPE: `float`

CLASS	DESCRIPTION
`HeaterMixin`	Mixin class for heater control

Documentation last updated: 2025-02-22

HeaterMixin

HeaterMixin(*args, **kwargs)

Mixin class for heater control

METHOD	DESCRIPTION
`atTemperature`	Check if temperature is reached
`getTemperature`	Get temperature
`holdTemperature`	Hold temperature
`setTemperature`	Set temperature

atTemperature

atTemperature(
    temperature: float,
    *,
    tolerance: float | None = None,
    **kwargs,
) -> bool

Check if at temperature

PARAMETER	DESCRIPTION
`temperature`	target temperature TYPE: `float`
`tolerance`	tolerance. Defaults to None. TYPE: `float` DEFAULT: `None`

RETURNS	DESCRIPTION
`bool`	at temperature TYPE: `bool`

getTemperature

getTemperature() -> float

Get temperature

RETURNS	DESCRIPTION
`float`	temperature TYPE: `float`

holdTemperature

holdTemperature(
    temperature: float,
    duration: float,
    blocking: bool = True,
    *,
    tolerance: float | None = None,
    release: Event | None = None,
) -> Event | None

Hold temperature

PARAMETER	DESCRIPTION
`temperature`	target temperature TYPE: `float`
`duration`	duration to hold temperature TYPE: `float`
`blocking`	blocking call. Defaults to True. TYPE: `bool` DEFAULT: `True`
`tolerance`	tolerance. Defaults to None. TYPE: `float` DEFAULT: `None`
`release`	release event. Defaults to None. TYPE: `Event` DEFAULT: `None`

RETURNS	DESCRIPTION
`Event \| None`	threading.Event: release event

setTemperature

setTemperature(
    temperature: float,
    blocking: bool = True,
    *,
    tolerance: float | None = None,
    release: Event | None = None,
) -> tuple[Thread, Event] | None

Set temperature

PARAMETER	DESCRIPTION
`temperature`	target temperature TYPE: `float`
`blocking`	blocking call. Defaults to True. TYPE: `bool` DEFAULT: `True`
`tolerance`	tolerance. Defaults to None. TYPE: `float` DEFAULT: `None`
`release`	release event. Defaults to None. TYPE: `Event` DEFAULT: `None`

RETURNS	DESCRIPTION
`tuple[Thread, Event] \| None`	tuple[threading.Thread, threading.Event]: thread and release event