Files
pybricks-api/pybricks/customdevices.py
T
Laurens Valk 653aa669b2 doc+api/customdevices: move AnalogSensor
Generic and custom devices like the AnalogSensor will live in a dedicated module.
2019-11-14 08:47:30 +01:00

62 lines
1.9 KiB
Python

"""Custom motors and sensors."""
class AnalogSensor():
"""Generic or custom analog sensor."""
def __init__(self, port, check_type=True):
"""AnalogSensor(port, check_type=True)
Arguments:
port (Port): Port to which the sensor is connected.
verify_type(bool): Verify that the sensor is detected as an analog
sensor (*Default*: ``True``).
If you choose ``verify_type=False``, the EV3 will treat it as
an analog sensor even if no such sensor is detected. This is
useful if you have a (custom) analog sensor that is not
detected automatically.
"""
pass
def voltage(self):
"""Measured analog voltage.
Returns:
:ref:`voltage`: Analog voltage.
"""
pass
def resistance(self):
"""Measured resistance.
This value is only meaningful if the analog device is a passive load
such as a resistor or thermistor.
Returns:
:ref:`resistance: Ω <voltage>`: Resistance of the analog device.
"""
pass
def active(self):
"""Set sensor to active mode. This sets pin 5 of the sensor
port to `high`.
This is used in some analog
sensors to control a switch. For example, if you use the NXT Light
Sensor as a custom analog sensor, this method will turn the light on.
From then on, ``voltage()`` returns the raw reflected light value.
"""
pass
def passive(self):
"""Set sensor to passive mode. This sets pin 5 of the sensor
port to `low`.
This is used in some analog
sensors to control a switch. For example, if you use the NXT Light
Sensor as a custom analog sensor, this method will turn the light off.
From then on, ``voltage()`` returns the raw ambient light value.
"""
pass