Merge pull request #132 from RaspberryPiFoundation/dev

Add motion sensor

Author: G3zz

docs/api.rst

@@ -101,6 +101,14 @@ Button
     :inherited-members:
     :members:
 
+MotionSensor
+------------
+
+.. autoclass:: MotionSensor
+    :show-inheritance:
+    :inherited-members:
+    :members: 
+
 Switch
 ------
 

docs/changelog.rst

@@ -3,6 +3,17 @@ Change log
 
 .. currentmodule:: picozero
 
+0.5.0 - 2025-10-31
+-----------
+
++ Introduced ``MotionSensor`` class for PIR sensors
+
+0.4.2 - 2023-05-12
+------------------
+
++ Bug fix relating to DigitalInputDevice bounce times
++ Updated tests after a change in micropython 1.20+
+
 0.4.1 - 2022-12-22
 ------------------
 

docs/conf.py

@@ -43,11 +43,11 @@ def __getattr__(cls, name):
 # -- Project information -----------------------------------------------------
 
 project = 'picozero'
-copyright = '2022, Raspberry Pi Foundation'
+copyright = '2025, Raspberry Pi Foundation'
 author = 'Raspberry Pi Foundation'
 
 # The full version, including alpha/beta/rc tags
-release = '0.4.1'
+release = '0.5.0'
 
 
 # -- General configuration ---------------------------------------------------
@@ -101,4 +101,4 @@ def __getattr__(cls, name):
 # -- Autodoc configuration ------------------------------------------------
 
 autodoc_member_order = 'groupwise'
-autodoc_default_flags = ['members']
+autodoc_default_flags = ['members']

docs/examples/motion_sensor.py

@@ -0,0 +1,15 @@
+from picozero import MotionSensor
+from time import sleep
+
+pir = MotionSensor(2)
+
+print("PIR Motion Sensor Example")
+print("Waiting for motion...")
+
+while True:
+    if pir.motion_detected:
+        print("Motion detected!")
+        sleep(1)
+    else:
+        print("No motion")
+        sleep(0.5)

docs/examples/motion_sensor_callbacks.py

@@ -0,0 +1,16 @@
+from picozero import MotionSensor, pico_led
+from time import sleep
+
+pir = MotionSensor(2)
+
+# Set up event callbacks
+pir.when_motion = pico_led.on
+pir.when_no_motion = pico_led.off
+
+# Keep the program running
+try:
+    while True:
+        sleep(1)
+except KeyboardInterrupt:
+    print("\nShutting down...")
+    pico_led.off()  # Make sure LED is off when exiting

docs/recipes.rst

@@ -145,6 +145,17 @@ Turn the :obj:`pico_led` on when a :class:`Button` is pressed and off when it is
 
 .. literalinclude:: examples/button_led.py
 
+Motion sensor
+-------------
+
+Detect motion using a PIR (Passive Infrared) sensor:
+
+.. literalinclude:: examples/motion_sensor.py
+
+Use callbacks to respond to motion events:
+
+.. literalinclude:: examples/motion_sensor_callbacks.py
+
 RGB LEDs
 --------
 

picozero/__init__.py

@@ -1,6 +1,6 @@
 __name__ = "picozero"
 __package__ = "picozero"
-__version__ = '0.4.1'
+__version__ = '0.5.0'
 __author__ = "Raspberry Pi Foundation"
 
 from .picozero import (
@@ -28,6 +28,7 @@
     DigitalInputDevice,
     Switch,
     Button,
+    MotionSensor,
 
     AnalogInputDevice,
     Potentiometer,