MagnetFieldStrength
- class phoenix5.sensors.MagnetFieldStrength(value: int)
Bases:
pybind11_objectIndicates the magnet field strength of a magnet-based sensor
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.
Members:
Invalid_Unknown : Magnet Field strength cannot be determined
BadRange_RedLED : Magnet field is far too low (too far) or far too high (too close).
Adequate_OrangeLED : Magnet field is adequate, sensor can be used in this range with slightly reduced accuracy.
Good_GreenLED : Magnet field is ideal
- Adequate_OrangeLED = <MagnetFieldStrength.Adequate_OrangeLED: 2>
- BadRange_RedLED = <MagnetFieldStrength.BadRange_RedLED: 1>
- Good_GreenLED = <MagnetFieldStrength.Good_GreenLED: 3>
- Invalid_Unknown = <MagnetFieldStrength.Invalid_Unknown: 0>
- property name
- property value