Sitelet https://github.com/lurch/python-gpiozero/blob/master/docs/api_output.rst
Skip to content

api_output.rst

Latest commit

 

History

History
96 lines (64 loc) · 2.23 KB

api_output.rst

File metadata and controls

96 lines (64 loc) · 2.23 KB
Raw

Output Devices

.. currentmodule:: gpiozero

These output device component interfaces have been provided for simple use of everyday components. Components must be wired up correctly before use in code.

Note

All GPIO pin numbers use Broadcom (BCM) numbering. See the :doc:`recipes` page for more information.

LED

.. autoclass:: LED(pin, active_high=True, initial_value=False)
    :members: on, off, toggle, blink, pin, is_lit

PWMLED

.. autoclass:: PWMLED(pin, active_high=True, initial_value=0, frequency=100)
    :members: on, off, toggle, blink, pulse, pin, is_lit, value

RGBLED

.. autoclass:: RGBLED(red, green, blue, active_high=True, initial_value=(0, 0, 0), pwm=True)
    :members: on, off, toggle, blink, pulse, red, green, blue, is_lit, color

Buzzer

.. autoclass:: Buzzer(pin, active_high=True, initial_value=False)
    :members: on, off, toggle, beep, pin, is_active

Motor

.. autoclass:: Motor(forward, backward, pwm=True)
    :members: forward, backward, stop

Servo

.. autoclass:: Servo(pin, initial_value=0, min_pulse_width=1/1000, max_pulse_width=2/1000, frame_width=20/1000)
    :inherited-members:
    :members:

AngularServo

.. autoclass:: AngularServo(pin, initial_angle=0, min_angle=-90, max_angle=90, min_pulse_width=1/1000, max_pulse_width=2/1000, frame_width=20/1000)
    :inherited-members:
    :members:

Base Classes

The classes in the sections above are derived from a series of base classes, some of which are effectively abstract. The classes form the (partial) hierarchy displayed in the graph below:

images/output_device_hierarchy.*

The following sections document these base classes for advanced users that wish to construct classes for their own devices.

DigitalOutputDevice

.. autoclass:: DigitalOutputDevice(pin, active_high=True, initial_value=False)
    :members:

PWMOutputDevice

.. autoclass:: PWMOutputDevice(pin, active_high=True, initial_value=0, frequency=100)
    :members:

OutputDevice

.. autoclass:: OutputDevice(pin, active_high=True, initial_value=False)
    :members:

GPIODevice

.. autoclass:: GPIODevice(pin)
    :members:
    :noindex: