libmygpio
libmygpio API documentation
Loading...
Searching...
No Matches
GPIO functions

This module provides functions to set and get values of a GPIO. More...

Functions

enum mygpio_gpio_value mygpio_gpioget (struct t_mygpio_connection *connection, unsigned gpio)
bool mygpio_gpioset (struct t_mygpio_connection *connection, unsigned gpio, enum mygpio_gpio_value value)
bool mygpio_gpiotoggle (struct t_mygpio_connection *connection, unsigned gpio)
bool mygpio_gpioblink (struct t_mygpio_connection *connection, unsigned gpio, int timeout_ms, int interval_ms)

Detailed Description

This module provides functions to set and get values of a GPIO.

Function Documentation

◆ mygpio_gpioblink()

bool mygpio_gpioblink ( struct t_mygpio_connection * connection,
unsigned gpio,
int timeout_ms,
int interval_ms )

Toggles the value of a configured output GPIO at given timeout and interval.

Parameters
connectionPointer to the connection struct returned by mygpio_connection_new.
gpioGPIO number
timeout_mstimeout in milliseconds
interval_msinterval in milliseconds, set it 0 to blink only once.
Returns
true on success, else false.

◆ mygpio_gpioget()

enum mygpio_gpio_value mygpio_gpioget ( struct t_mygpio_connection * connection,
unsigned gpio )

Returns the current value of a configured input or output GPIO.

Parameters
connectionPointer to the connection struct returned by mygpio_connection_new.
gpioGPIO number
Returns
Value of the GPIO or MYGPIO_GPIO_VALUE_UNKNOWN on error.

◆ mygpio_gpioset()

bool mygpio_gpioset ( struct t_mygpio_connection * connection,
unsigned gpio,
enum mygpio_gpio_value value )

Sets the value of a configured output GPIO.

Parameters
connectionPointer to the connection struct returned by mygpio_connection_new.
gpioGPIO number
valueValue to set: MYGPIO_GPIO_VALUE_INACTIVE or MYGPIO_GPIO_VALUE_ACTIVE
Returns
true on success, else false.

◆ mygpio_gpiotoggle()

bool mygpio_gpiotoggle ( struct t_mygpio_connection * connection,
unsigned gpio )

Toggles the value of a configured output GPIO.

Parameters
connectionPointer to the connection struct returned by mygpio_connection_new.
gpioGPIO number
Returns
true on success, else false.