pmk_probes.probes.BumbleBee1kV

class BumbleBee1kV(*args, **kwargs)

Bases: _BumbleBee

Class for controlling PMK BumbleBee probes with ±1000 V input voltage. See http://www.pmk.de/en/en/bumblebee for specifications.

Methods

`clear_overload_counters`	Clears the BumbleBee's overload counters `overload_positive_counter`, `overload_negative_counter` and `overload_main_counter`.
`decrease_attenuation`	Decreases the attenuation setting of the BumbleBee by one step relative to `attenuation`.
`decrease_offset_extra_large`	Decreases the offset setting of the BumbleBee by `offset_step_extra_large`.
`decrease_offset_large`	Decreases the offset setting of the BumbleBee by `offset_step_large`.
`decrease_offset_small`	Decreases the offset setting of the BumbleBee by `offset_step_small`.
`factory_reset`	Resets the BumbleBee to factory settings.
`increase_attenuation`	Increases the attenuation setting of the BumbleBee by one step relative to `attenuation`.
`increase_offset_extra_large`	Increases the offset setting of the BumbleBee by `offset_step_extra_large`.
`increase_offset_large`	Increases the offset setting of the BumbleBee by `offset_step_large`.
`increase_offset_small`	Increases the offset setting of the BumbleBee by `offset_step_small`.
`unlock_eeprom`

Attributes

`attenuation`	Read or write the current attenuation setting of the probe.
`global_offset`	Return the global offset in V.
`hold_overload`	Read or write the hold overload setting.
`keylock`	Attribute that determines whether the probe's keyboard is locked.
`led_color`	Attribute that determines the probe's status LED color.
`leds_off`	Attribute that determines whether the probe's LEDs (status, attenuation and overload LEDs) are off, for example in photosensitive environments.
`metadata`	Read the probe's metadata.
`metadata_write_protection_password`
`offset_step_extra_large`	Read or write the extra large offset step size in V.
`offset_step_large`	Read or write the large offset step size in V.
`offset_step_small`	Read or write the small offset step size in V.
`offset_sync`	Read or write the offset synchronization setting.
`overload_buzzer`	Read or write the overload buzzer setting.
`overload_main_counter`	Returns the number of times the probe has been overloaded in the main path since the last call of `clear_overload_counters()`.
`overload_negative_counter`	Returns the number of times the probe has been overloaded in the negative direction since the last call of `clear_overload_counters()`.
`overload_positive_counter`	Returns the number of times the probe has been overloaded in the positive direction since the last call of `clear_overload_counters()`.
`properties`	Properties of the specific probe model, similar to metadata but stored in the Python package instead of the probe's flash.
`temperature`	Get the temperature of the probe in °C.

property attenuation: int

Read or write the current attenuation setting of the probe.

Getter:: Returns the current attenuation setting.
Setter:: Sets the attenuation setting.

clear_overload_counters() → None

Clears the BumbleBee’s overload counters overload_positive_counter, overload_negative_counter and overload_main_counter.

Returns:: None

decrease_attenuation() → None

Decreases the attenuation setting of the BumbleBee by one step relative to attenuation.

Returns:: None

decrease_offset_extra_large() → None

Decreases the offset setting of the BumbleBee by offset_step_extra_large.

Returns:: None

decrease_offset_large() → None

Decreases the offset setting of the BumbleBee by offset_step_large.

Returns:: None

decrease_offset_small() → None

Decreases the offset setting of the BumbleBee by offset_step_small.

Returns:: None

factory_reset() → None

Resets the BumbleBee to factory settings.

Returns:: None

property global_offset

Return the global offset in V.

Getter:: Read the global offset from the probe.
Setter:: Write the global offset to the probe.

property hold_overload

Read or write the hold overload setting. If set to True, overload will be held until hold overload is disabled. If set to False, overload is only shown as long as the probe is overloaded.

Getter:: Returns the hold overload setting.
Setter:: Sets the hold overload setting.

increase_attenuation() → None

Increases the attenuation setting of the BumbleBee by one step relative to attenuation.

Returns:: None

increase_offset_extra_large() → None

Increases the offset setting of the BumbleBee by offset_step_extra_large.

Returns:: None

increase_offset_large() → None

Increases the offset setting of the BumbleBee by offset_step_large.

Returns:: None

increase_offset_small() → None

Increases the offset setting of the BumbleBee by offset_step_small.

Returns:: None

property keylock

Attribute that determines whether the probe’s keyboard is locked.

Getter:: Returns the current keylock state.
Setter:: Sets the keylock state. (True means ON, False means OFF)

property led_color

Attribute that determines the probe’s status LED color. Allowed colors are red, green, blue, magenta, cyan, yellow, white, black (off).

Getter:: Returns the current LED color.
Setter:: Sets the LED color.

property leds_off

Attribute that determines whether the probe’s LEDs (status, attenuation and overload LEDs) are off, for example in photosensitive environments.

Getter:: Returns the current ‘LEDs off’ state.
Setter:: Sets the ‘LEDs off’ state.

property metadata: PMKMetadata

Read the probe’s metadata.

Getter:: Returns the probe’s metadata.

property offset_step_extra_large

Read or write the extra large offset step size in V. This step size is used when the user presses the extra large offset step button combination (one arrow + two arrows at once) or when the increase_offset_extra_large() or decrease_offset_extra_large() methods are called.

Getter:: Read the extra large offset step size from the probe.
Setter:: Write the extra large offset step size to the probe.

property offset_step_large

Read or write the large offset step size in V. This step size is used when the user presses the large offset step button (two arrows) or when the increase_offset_large() or decrease_offset_large() methods are called.

Getter:: Read the large offset step size from the probe.
Setter:: Write the large offset step size to the probe.

property offset_step_small

Read or write the small offset step size in V. This step size is used when the user presses the small offset step button (one arrow) or when the increase_offset_small() or decrease_offset_small() methods are called.

Setter:: Write the small offset step size to the probe.
Getter:: Read the small offset step size from the probe.

property offset_sync: bool

Read or write the offset synchronization setting. If set to True, the offset will be synchronized for all attenuation settings, otherwise it is scaled proportionally when switching the attenuation ratio.

Getter:: Returns the offset synchronization setting.
Setter:: Sets the offset synchronization setting.

property overload_buzzer

Read or write the overload buzzer setting. If set to True, the buzzer will sound whenever an overload is active, otherwise buzzer is disabled.

Getter:: Returns the overload buzzer setting.
Setter:: Sets the overload buzzer setting.

property overload_main_counter: int

Returns the number of times the probe has been overloaded in the main path since the last call of clear_overload_counters().

Returns:: The number of times the probe has been overloaded on the main path.

property overload_negative_counter: int

Returns the number of times the probe has been overloaded in the negative direction since the last call of clear_overload_counters().

Returns:: The number of times the probe has been overloaded on the negative path.

property overload_positive_counter: int

Returns the number of times the probe has been overloaded in the positive direction since the last call of clear_overload_counters().

Returns:: The number of times the probe has been overloaded on the positive path.

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

property temperature: float

Get the temperature of the probe in °C.

Returns:: The temperature of the probe in °C.