Data Structures
struct	IoConfig
	IO Configuration Structure. More...
class	MeshXIoFactory
	IO Factory Class. More...
class	MeshXIoInterface
	Abstract IO Interface. More...
class	MeshXGpioImpl
	Concrete GPIO Implementation Class. More...
class	MeshXPwmImpl
	Concrete PWM Implementation Class. More...

Typedefs
using	IoFactoryFunction = std::unique_ptr<MeshXIoInterface>()(uint8_t logical_pin, const char name)
	IO Factory function type.

Enumerations
enum class	IoType { GPIO , PWM , ADC , DAC , CUSTOM }
	IO Type enumeration. More...
enum class	IoFunction { SET_LEVEL = 0 , GET_LEVEL , TOGGLE , SET_PWM_DUTY , SET_PWM_FREQUENCY , REGISTER_INTERRUPT , UNREGISTER_INTERRUPT , ENABLE_INTERRUPT , CUSTOM_FUNCTION , FUNCTION_MAX }
	IO Function Types for function-based API. More...
enum class	GpioMode { INPUT = 0 , OUTPUT , INPUT_OUTPUT , OPEN_DRAIN , OPEN_DRAIN_INPUT_OUTPUT , PWM_OUTPUT , MODE_MAX }
	GPIO Mode enumeration. More...
enum class	GpioPull { NONE = 0 , PULL_UP , PULL_DOWN , PULL_UP_DOWN , PULL_MAX }
	GPIO Pull Resistor enumeration. More...
enum class	GpioDrive { WEAK = 0 , MEDIUM , STRONG , MAX_STRONG , DRIVE_MAX }
	GPIO Drive Strength enumeration. More...
enum class	GpioIntrTrigger { DISABLED = 0 , POSITIVE_EDGE , NEGATIVE_EDGE , ANY_EDGE , LOW_LEVEL , HIGH_LEVEL , INTR_MAX }
	GPIO Interrupt Trigger enumeration. More...
enum class	HostedMode { NON_HOSTED = 0 , HOSTED , TRANSITIONING }
	Hosted Mode enumeration. More...
enum class	IoError { SUCCESS = 0 , INVALID_PIN , INVALID_MODE , INVALID_LEVEL , INVALID_ARG , INTR_NOT_SUPPORTED , INTR_ALREADY_REGISTERED , PWM_NOT_SUPPORTED , PWM_INVALID_PARAM , NOT_SUPPORTED , NOT_INITIALIZED , CONFIG_INVALID , HOSTED_MODE , KV_STORAGE , SERIALIZATION , ERROR_MAX }
	IO Error Codes. More...

Functions
const char *	ioErrorToString (IoError error)
	Convert IO error to string.
const char *	gpioModeToString (GpioMode mode)
	Convert GPIO mode to string.
GpioMode	stringToGpioMode (const char *str)
	Convert string to GPIO mode.
const char *	gpioPullToString (GpioPull pull)
	Convert GPIO pull to string.
GpioPull	stringToGpioPull (const char *str)
	Convert string to GPIO pull.
const char *	gpioDriveToString (GpioDrive drive)
	Convert GPIO drive to string.
GpioDrive	stringToGpioDrive (const char *str)
	Convert string to GPIO drive.
const char *	intrTriggerToString (GpioIntrTrigger trigger)
	Convert interrupt trigger to string.
GpioIntrTrigger	stringToIntrTrigger (const char *str)
	Convert string to interrupt trigger.
static void	meshx_gpio_intr_cb_wrapper (uint8_t logical_pin, void *user_data)
	Static interrupt callback wrapper for C API.
std::unique_ptr< MeshXIoInterface >	createGpioInstance (uint8_t logical_pin, const char *name)
	Factory function for creating GPIO instances.
std::unique_ptr< MeshXIoInterface >	createPwmInstance (uint8_t logical_pin, const char *name)
	Factory function for creating PWM instances.

Typedef Documentation

◆ IoFactoryFunction

using meshx::IoFactoryFunction = std::unique_ptr<MeshXIoInterface>(*)(uint8_t logical_pin, const char* name)

IO Factory function type.

Enumeration Type Documentation

◆ GpioDrive

enum class meshx::GpioDrive

strong

GPIO Drive Strength enumeration.

Enumerator
WEAK	0	Weak drive strength
MEDIUM		Medium drive strength
STRONG		Strong drive strength
MAX_STRONG		Maximum strong drive strength
DRIVE_MAX		Maximum drive value

                     {
    WEAK = 0,                      /**< Weak drive strength */
    MEDIUM,                        /**< Medium drive strength */
    STRONG,                        /**< Strong drive strength */
    MAX_STRONG,                    /**< Maximum strong drive strength */
    DRIVE_MAX                      /**< Maximum drive value */
};

◆ GpioIntrTrigger

enum class meshx::GpioIntrTrigger

strong

GPIO Interrupt Trigger enumeration.

Enumerator
DISABLED	0	Interrupt disabled
POSITIVE_EDGE		Positive edge trigger
NEGATIVE_EDGE		Negative edge trigger
ANY_EDGE		Any edge trigger
LOW_LEVEL		Low level trigger
HIGH_LEVEL		High level trigger
INTR_MAX		Maximum interrupt type

                           {
    DISABLED = 0,                  /**< Interrupt disabled */
    POSITIVE_EDGE,                 /**< Positive edge trigger */
    NEGATIVE_EDGE,                 /**< Negative edge trigger */
    ANY_EDGE,                      /**< Any edge trigger */
    LOW_LEVEL,                     /**< Low level trigger */
    HIGH_LEVEL,                    /**< High level trigger */
    INTR_MAX                       /**< Maximum interrupt type */
};

◆ GpioMode

enum class meshx::GpioMode

strong

GPIO Mode enumeration.

Enumerator
INPUT	0	Input only mode
OUTPUT		Output only mode
INPUT_OUTPUT		Input and output mode
OPEN_DRAIN		Open drain output mode
OPEN_DRAIN_INPUT_OUTPUT		Open drain input/output mode
PWM_OUTPUT		PWM output mode
MODE_MAX		Maximum mode value

                    {
    INPUT = 0,                     /**< Input only mode */
    OUTPUT,                        /**< Output only mode */
    INPUT_OUTPUT,                  /**< Input and output mode */
    OPEN_DRAIN,                    /**< Open drain output mode */
    OPEN_DRAIN_INPUT_OUTPUT,       /**< Open drain input/output mode */
    PWM_OUTPUT,                    /**< PWM output mode */
    MODE_MAX                       /**< Maximum mode value */
};

◆ GpioPull

enum class meshx::GpioPull

strong

GPIO Pull Resistor enumeration.

Enumerator
NONE	0	No pull resistor
PULL_UP		Pull-up resistor
PULL_DOWN		Pull-down resistor
PULL_UP_DOWN		Both pull-up and pull-down
PULL_MAX		Maximum pull value

                    {
    NONE = 0,                      /**< No pull resistor */
    PULL_UP,                       /**< Pull-up resistor */
    PULL_DOWN,                     /**< Pull-down resistor */
    PULL_UP_DOWN,                  /**< Both pull-up and pull-down */
    PULL_MAX                       /**< Maximum pull value */
};

◆ HostedMode

enum class meshx::HostedMode

strong

Hosted Mode enumeration.

Enumerator
NON_HOSTED	0	Non-hosted mode (direct IO access)
HOSTED		Hosted mode (UART transport)
TRANSITIONING		Mode transition in progress

                      {
    NON_HOSTED = 0,                /**< Non-hosted mode (direct IO access) */
    HOSTED,                        /**< Hosted mode (UART transport) */
    TRANSITIONING                  /**< Mode transition in progress */
};

◆ IoError

enum class meshx::IoError

strong

IO Error Codes.

Enumerator
SUCCESS	0	Success
INVALID_PIN		Invalid pin number
INVALID_MODE		Invalid mode for operation
INVALID_LEVEL		Invalid level value
INVALID_ARG		Invalid argument
INTR_NOT_SUPPORTED		Interrupt not supported
INTR_ALREADY_REGISTERED		Interrupt already registered
PWM_NOT_SUPPORTED		PWM not supported
PWM_INVALID_PARAM		Invalid PWM parameter
NOT_SUPPORTED		Operation not supported
NOT_INITIALIZED		IO subsystem not initialized
CONFIG_INVALID		Invalid configuration
HOSTED_MODE		Operation not allowed in hosted mode
KV_STORAGE		KV Engine storage error
SERIALIZATION		Configuration serialization error
ERROR_MAX		Maximum error value

                   {
    SUCCESS = 0,                   /**< Success */
    INVALID_PIN,                   /**< Invalid pin number */
    INVALID_MODE,                  /**< Invalid mode for operation */
    INVALID_LEVEL,                 /**< Invalid level value */
    INVALID_ARG,                   /**< Invalid argument */
    INTR_NOT_SUPPORTED,            /**< Interrupt not supported */
    INTR_ALREADY_REGISTERED,       /**< Interrupt already registered */
    PWM_NOT_SUPPORTED,             /**< PWM not supported */
    PWM_INVALID_PARAM,             /**< Invalid PWM parameter */
    NOT_SUPPORTED,                 /**< Operation not supported */
    NOT_INITIALIZED,               /**< IO subsystem not initialized */
    CONFIG_INVALID,                /**< Invalid configuration */
    HOSTED_MODE,                   /**< Operation not allowed in hosted mode */
    KV_STORAGE,                    /**< KV Engine storage error */
    SERIALIZATION,                 /**< Configuration serialization error */
    ERROR_MAX                      /**< Maximum error value */
};

◆ IoFunction

enum class meshx::IoFunction

strong

IO Function Types for function-based API.

Enumerator
SET_LEVEL	0	Set pin level function
GET_LEVEL		Get pin level function
TOGGLE		Toggle pin function
SET_PWM_DUTY		Set PWM duty cycle function
SET_PWM_FREQUENCY		Set PWM frequency function
REGISTER_INTERRUPT		Register interrupt function
UNREGISTER_INTERRUPT		Unregister interrupt function
ENABLE_INTERRUPT		Enable/disable interrupt function
CUSTOM_FUNCTION		Custom function (for extensibility)
FUNCTION_MAX		Maximum function type

                      {
    SET_LEVEL = 0,          /**< Set pin level function */
    GET_LEVEL,              /**< Get pin level function */
    TOGGLE,                 /**< Toggle pin function */
    SET_PWM_DUTY,           /**< Set PWM duty cycle function */
    SET_PWM_FREQUENCY,      /**< Set PWM frequency function */
    REGISTER_INTERRUPT,     /**< Register interrupt function */
    UNREGISTER_INTERRUPT,   /**< Unregister interrupt function */
    ENABLE_INTERRUPT,       /**< Enable/disable interrupt function */
    CUSTOM_FUNCTION,        /**< Custom function (for extensibility) */
    FUNCTION_MAX            /**< Maximum function type */
};

◆ IoType

enum class meshx::IoType

strong

IO Type enumeration.

Enumerator
GPIO	General Purpose Input/Output
PWM	Pulse Width Modulation
ADC	Analog to Digital Converter (future)
DAC	Digital to Analog Converter (future)
CUSTOM	Custom IO type

                  {
    GPIO,          /**< General Purpose Input/Output */
    PWM,           /**< Pulse Width Modulation */
    ADC,           /**< Analog to Digital Converter (future) */
    DAC,           /**< Digital to Analog Converter (future) */
    CUSTOM         /**< Custom IO type */
};

Function Documentation

◆ createGpioInstance()

std::unique_ptr< MeshXIoInterface > meshx::createGpioInstance	(	uint8_t	logical_pin,
		const char *	name )

Factory function for creating GPIO instances.

Parameters

logical_pin	Logical pin number
name	Pin name

Returns: std::unique_ptr<MeshXIoInterface> IO interface instance

                                                                                          {
    // Default to output mode for GPIO
    return std::make_unique<MeshXGpioImpl>(logical_pin, name, GpioMode::OUTPUT);
}

◆ createPwmInstance()

std::unique_ptr< MeshXIoInterface > meshx::createPwmInstance	(	uint8_t	logical_pin,
		const char *	name )

Factory function for creating PWM instances.

Parameters

logical_pin	Logical pin number
name	Pin name

Returns: std::unique_ptr<MeshXIoInterface> IO interface instance

                                                                                         {
    return std::make_unique<MeshXPwmImpl>(logical_pin, name);
}

◆ gpioDriveToString()

const char * meshx::gpioDriveToString ( GpioDrive drive )

Convert GPIO drive to string.

Parameters

drive GPIO drive strength

Returns: const char* Drive string

◆ gpioModeToString()

const char * meshx::gpioModeToString ( GpioMode mode )

Convert GPIO mode to string.

Parameters

mode GPIO mode

Returns: const char* Mode string

◆ gpioPullToString()

const char * meshx::gpioPullToString ( GpioPull pull )

Convert GPIO pull to string.

Parameters

pull	GPIO pull setting

Returns: const char* Pull string

◆ intrTriggerToString()

const char * meshx::intrTriggerToString ( GpioIntrTrigger trigger )

Convert interrupt trigger to string.

Parameters

trigger Interrupt trigger type

Returns: const char* Trigger string

◆ ioErrorToString()

const char * meshx::ioErrorToString ( IoError error )

Convert IO error to string.

Parameters

error IO error code

Returns: const char* Error string

◆ meshx_gpio_intr_cb_wrapper()

void meshx::meshx_gpio_intr_cb_wrapper	(	uint8_t	logical_pin,
		void *	user_data )

static

Static interrupt callback wrapper for C API.

Parameters

logical_pin	Logical pin number
user_data	User data (pointer to MeshXGpioImpl instance)

{
    MeshXGpioImpl* instance = static_cast<MeshXGpioImpl*>(user_data);
    if (instance != nullptr && instance->m_intr_callback != nullptr) {
        instance->m_intr_callback(logical_pin, instance->m_intr_user_data);
    }
}

◆ stringToGpioDrive()

GpioDrive meshx::stringToGpioDrive ( const char * str )

Convert string to GPIO drive.

Parameters

str	Drive string

Returns: GpioDrive GPIO drive strength

◆ stringToGpioMode()

GpioMode meshx::stringToGpioMode ( const char * str )

Convert string to GPIO mode.

Parameters

str	Mode string

Returns: GpioMode GPIO mode

◆ stringToGpioPull()

GpioPull meshx::stringToGpioPull ( const char * str )

Convert string to GPIO pull.

Parameters

str	Pull string

Returns: GpioPull GPIO pull setting

◆ stringToIntrTrigger()

GpioIntrTrigger meshx::stringToIntrTrigger ( const char * str )

Convert string to interrupt trigger.

Parameters

str	Trigger string

Returns: GpioIntrTrigger Interrupt trigger type

Data Structures

Typedefs

Enumerations

Functions

Typedef Documentation

◆ IoFactoryFunction

Enumeration Type Documentation

◆ GpioDrive

◆ GpioIntrTrigger

◆ GpioMode

◆ GpioPull

◆ HostedMode

◆ IoError

◆ IoFunction

◆ IoType

Function Documentation

◆ createGpioInstance()

◆ createPwmInstance()

◆ gpioDriveToString()

◆ gpioModeToString()

◆ gpioPullToString()

◆ intrTriggerToString()

◆ ioErrorToString()

◆ meshx_gpio_intr_cb_wrapper()

◆ stringToGpioDrive()

◆ stringToGpioMode()

◆ stringToGpioPull()

◆ stringToIntrTrigger()