mirror of
https://git.intern.spaceteamaachen.de/ALPAKA/sta-core.git
synced 2025-08-06 02:27:33 +00:00
Updated: Doxygen Documentation
This commit is contained in:
committed by
CarlWachter
parent
b3ed26e288
commit
16b9e6135c
@@ -20,6 +20,11 @@ namespace sta
|
||||
GPIO_INPUT
|
||||
};
|
||||
|
||||
/**
|
||||
* @brief A wrapper class for Raspi GPIO pins.
|
||||
*
|
||||
* @ingroup sta_core_raspi
|
||||
*/
|
||||
class RaspiGpioPin : public GpioPin
|
||||
{
|
||||
public:
|
||||
@@ -29,10 +34,21 @@ namespace sta
|
||||
*/
|
||||
RaspiGpioPin(uint8_t pin, GpioMode mode);
|
||||
|
||||
/**
|
||||
* @brief Set the state of the GPIO pin.
|
||||
*
|
||||
* @param state The state of the GPIO pin. Either HIGH or LOW
|
||||
*/
|
||||
void setState(GpioPinState state) override;
|
||||
|
||||
/**
|
||||
* @brief Get the state of the GPIO pin.
|
||||
*
|
||||
* @return The state of the GPIO pin. Either HIGH or LOW
|
||||
*/
|
||||
GpioPinState getState() override;
|
||||
|
||||
/// @brief Dummy GPIO pin
|
||||
static RaspiGpioPin * DUMMY_GPIO;
|
||||
|
||||
private:
|
||||
|
@@ -5,4 +5,10 @@
|
||||
#include <stdio.h>
|
||||
#include <sys/ioctl.h>
|
||||
|
||||
/**
|
||||
* @defgroup sta_core_raspi Raspi
|
||||
* @ingroup sta_core_platforms
|
||||
* @brief Modules implemented for the Raspi platform.
|
||||
*/
|
||||
|
||||
#endif //STA_CORE_RASPI_HAL_HPP
|
||||
|
Reference in New Issue
Block a user