Extending MudPi

Overview

MudPi is designed to be extended. Whether you need to support a new sensor type, add a custom component, or integrate with third-party hardware, you can build on MudPi's architecture without modifying the core.

Adding a New Sensor Type

Let's walk through adding a motion sensor to MudPi. We'll create a MotionSensor class that extends the base Sensor component.

from mudpi.extensions.sensor import Sensor
import RPi.GPIO as GPIO

class MotionSensor(Sensor):
    """PIR motion sensor implementation."""

    def init_sensor(self):
        """Set up the GPIO pin for the motion sensor."""
        self.pin = self.config.get('pin')
        GPIO.setmode(GPIO.BCM)
        GPIO.setup(self.pin, GPIO.IN)
        self.state = False

    def read(self):
        """Read the current motion state from the PIR sensor."""
        motion_detected = GPIO.input(self.pin)
        self.state = bool(motion_detected)
        return self.state

Loading Your Custom Sensor

Once your sensor class is in place, load it through your MudPi configuration:

{
  "sensor": [
    {
      "key": "front_door_motion",
      "interface": "motion",
      "pin": 23,
      "name": "Front Door Motion Sensor"
    }
  ]
}

Dependency Versions for Extension Authors

As of MudPi v0.11.0, the core requires Python 3.9+ and uses the following key libraries. If your extension imports these directly, be aware of the version requirements:

Submit Your Extension

Built something useful? We'd love to include it in MudPi! Submit a pull request to the MudPi repository with your extension and documentation. Check the contributing guide for details on how to submit your work.