Struct GpioHandler

pub struct GpioHandler {}

Contains the configuration and the implementation for the GPIO handler.

Implementations

impl GpioHandler

pub fn check_valid_gpio_pin_config( config: &GpioHandlerConfig, ) -> Result<(), GpioHandlerError>

Checks if the GPIO pin configuration is valid and free from conflicts.

This function performs two essential validation checks on the configured GPIO pins:

1. Range Check: Ensures all pins fall within the permissible operating range defined by GPIO_MIN and GPIO_MAX.
2. Uniqueness Check: Verifies that all assigned pins are distinct, preventing multiple devices from being configured to the same physical pin.

Arguments

• config - The GpioHandlerConfig struct containing the GPIO pin assignments.

Returns

An empty Result (Ok(())) if all GPIO pins are valid.

Errors

Returns a GpioHandlerError if any validation check fails:

• GpioHandlerError::PinOutsideRange: If any configured GPIO pin is outside the valid range (e.g., less than or equal to 3, or greater than or equal to 28).
• GpioHandlerError::PinDuplicateValue: If the same GPIO pin is assigned to more than one device.

pub fn new( config: GpioHandlerConfig, ) -> Result<Option<GpioHandler>, GpioHandlerError>

Creates a new GpioHandler instance for development or non-target platforms.

This constructor is activated when compiling for a non-Linux OS or when the target_hw feature is disabled. It allows the application to run in a simulated mode without requiring real GPIO hardware.

Arguments

• config - Configuration data for the GPIO handler.

Returns

A Result containing Ok(None) if the configuration is valid and use_simulator is true, indicating that no hardware handle is needed.

Errors

Returns a GpioHandlerError if initialization fails:

• GpioHandlerError::PlatformNotSupported: If use_simulator is false, as hardware access is not possible on the current platform.
• GpioHandlerError::PinOutsideRange or PinDuplicateValue: If the pin configuration is invalid (propagated from check_valid_gpio_pin_config)