2.6 KiB
Input Devices
These input device component interfaces have been provided for simple use of everyday components.
Components must be wired up correctly before used in code.
Note all GPIO pin numbers use BCM numbering. See the notes page for more information.
Button
A physical push button or switch.
Wiring
...
Code
Ensure the Button class is imported at the top of the file:
from gpiozero import Button
Create a Button object by passing in the pin number the button is connected to:
button = Button(2)
The default bahaviour is to set the pull state of the button to up. To change this behaviour, set the pull_up argument to False when creating your Button object.
button = Button(pin=2, pull_up=False)
Methods
| Method | Description | Arguments |
|---|---|---|
wait_for_press() |
Halt the program until the button is pressed. | timeout=None |
wait_for_release() |
Halt the program until the button is released. | timeout=None |
Properties
| Property | Description | Type |
|---|---|---|
pin |
The GPIO pin number the button is connected to. | Integer |
is_pressed |
The current state of the pin (True if pressed; otherwise False). |
Boolean |
pull_up |
The pull state of the pin (True if pulled up; False if pulled down). |
Boolean |
when_pressed |
A reference to the function to be called when the button is pressed. | None or Function |
when_released |
A reference to the function to be called when the button is released. | None or Function |
Motion Sensor
A PIR (Passive Infra-Red) motion sensor.
Wiring
...
Code
Ensure the MotionSensor class is imported at the top of the file:
from gpiozero import MotionSensor
Create a MotionSensor object by passing in the pin number the sensor is connected to:
pir = MotionSensor(3)
Methods
...
Properties
...
Light Sensor
An LDR (Light Dependent Resistor) Light Sensor.
Wiring
...
Code
Ensure the LightSensor class is imported at the top of the file:
from gpiozero import LightSensor
Create a LightSensor object by passing in the pin number the sensor is connected to:
light = LightSensor(4)
Methods
...
Properties
...
Temperature Sensor
Digital Temperature Sensor.
Wiring
...
Code
Ensure the TemperatureSensor class is imported at the top of the file:
from gpiozero import TemperatureSensor
Create a TemperatureSensor object:
temp = TemperatureSensor()
Properties
...
Methods
...