StatorCurrentLimitConfiguration

class phoenix5.StatorCurrentLimitConfiguration(*args, **kwargs)

Bases: pybind11_object

Describes the desired stator current limiting behavior.

If the Phoenix 5 API must be used for this device, the device must have 22.X firmware. This firmware is available in Tuner X after selecting Phoenix 5 in the firmware year dropdown.

Deprecated:

This device’s Phoenix 5 API is deprecated for removal in the 2025 season. Users should update to Phoenix 6 firmware and migrate to the Phoenix 6 API. A migration guide is available at https://v6.docs.ctr-electronics.com/en/stable/docs/migration/migration-guide/index.html.

Overloaded function.

  1. __init__(self: phoenix5._ctre.StatorCurrentLimitConfiguration) -> None

Default c’tor. Because currentLimit is zero, limiting id disabled.

  1. __init__(self: phoenix5._ctre.StatorCurrentLimitConfiguration, enable: bool, currentLimit: float, triggerThresholdCurrent: float, triggerThresholdTime: float) -> None

property currentLimit

The “holding” current (amperes) to limit to when feature is activated.

property enable

True/False to enable/disable limit feature.

toArray() → list[float]
property triggerThresholdCurrent

Current must exceed this threshold (amperes) before limiting occurs. If this value is less than currentLimit, then currentLimit is used as the threshold.

property triggerThresholdTime

How long current must exceed threshold (seconds) before limiting occurs.