pmk_probes.probes.FireFly

class FireFly(power_supply: _PMKPowerSupply, channel: Channel, verbose: bool = False, allow_legacy: bool = False, simulated=None, skip_metadata=False)

Bases: _PMKProbe

Class for controlling the FireFly probe. See http://www.pmk.de/en/products/firefly for specifications.

Methods

auto_zero

enable_expert_mode

Attributes

battery_indicator

Returns the state of the battery indicator LEDs on the _interface board.

battery_voltage

Return the current battery voltage in V.

metadata

Read the probe's metadata.

probe_head_on

Attribute that determines whether the probe head is on or off.

probe_status_led

Returns the state of the probe status LED.

properties

Properties of the specific probe model, similar to metadata but stored in the Python package instead of the probe's flash.

class ProbeStates(value)

Bases: Enum

Enumeration of the possible states of the FireFly probe indicated by the Probe Status LED.

property battery_indicator: tuple[pmk_probes._data_structures.LED, pmk_probes._data_structures.LED, pmk_probes._data_structures.LED, pmk_probes._data_structures.LED]

Returns the state of the battery indicator LEDs on the _interface board.

The tuple contains the states of the four physical LEDs from bottom to top.

property battery_voltage: float

Return the current battery voltage in V.

Caution: This value is not available immediately after turning off the probe head. It takes approximately 200 milliseconds to become available. Before that the battery voltage will read as 0.0.

property metadata: FireFlyMetadata

Read the probe’s metadata.

property probe_head_on: bool

Attribute that determines whether the probe head is on or off.

Getter:

Returns the current state of the probe head.

Setter:

Sets the state of the probe head and waits until the attribute change is confirmed by the probe.

property probe_status_led: ProbeStates

Returns the state of the probe status LED.

property properties: PMKProbeProperties

Properties of the specific probe model, similar to metadata but stored in the Python package instead of the probe’s flash.