SHS/pip
4
3
Fork 0
Code Issues 67 Pull Requests 1 Actions Releases Wiki Activity

doxygen @ tags replaced to \

Browse Source
This commit is contained in:
Пелипенко Иван
2022-03-14 21:19:31 +03:00
parent 9bf1a11701
commit 54b5372356
142 changed files with 1079 additions and 1079 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
libs/main/io_devices/pigpio.h
View File

@@ -1,5 +1,5 @@
/*! @file pigpio.h
* @brief GPIO
/*! \file pigpio.h
* \brief GPIO
*/
/*
PIP - Platform Independent Primitives
@@ -33,41 +33,41 @@ public:
PIGPIO();
virtual ~PIGPIO();
//! @brief Work mode for pin
//! \brief Work mode for pin
enum Direction {
In /** Input direction (read) */,
Out /** Output direction (write) */
};
//! @brief Returns singleton object of %PIGPIO
//! \brief Returns singleton object of %PIGPIO
static PIGPIO * instance();
//! @brief Initialize pin \"gpio_num\" for \"dir\" mode
//! \brief Initialize pin \"gpio_num\" for \"dir\" mode
void initPin(int gpio_num, Direction dir = PIGPIO::In);
//! @brief Set pin \"gpio_num\" value to \"value\"
//! \brief Set pin \"gpio_num\" value to \"value\"
void pinSet (int gpio_num, bool value);
//! @brief Set pin \"gpio_num\" value to \b true
//! \brief Set pin \"gpio_num\" value to \b true
void pinHigh (int gpio_num) {pinSet(gpio_num, true );}
//! @brief Set pin \"gpio_num\" value to \b false
//! \brief Set pin \"gpio_num\" value to \b false
void pinLow (int gpio_num) {pinSet(gpio_num, false);}
//! @brief Returns pin \"gpio_num\" state
//! \brief Returns pin \"gpio_num\" state
bool pinState(int gpio_num);
//! @brief Starts watch for pin \"gpio_num\".
//! \brief Starts watch for pin \"gpio_num\".
//! \details Pins watching starts only with \a PIThread::start() function!
//! This function doesn`t affect thread state
void pinBeginWatch(int gpio_num);
//! @brief End watch for pin \"gpio_num\".
//! \brief End watch for pin \"gpio_num\".
//! \details Pins watching starts only with \a PIThread::start() function!
//! This function doesn`t affect thread state
void pinEndWatch (int gpio_num);
//! @brief End watch for all pins.
//! \brief End watch for all pins.
//! \details Pins watching starts only with \a PIThread::start() function!
//! This function doesn`t affect thread state
void clearWatch();
@@ -78,7 +78,7 @@ public:
//! \{
//! \fn void pinChanged(int gpio_num, bool new_value)
//! @brief Raise on pin \"gpio_num\" state changes to \"new_value\"
//! \brief Raise on pin \"gpio_num\" state changes to \"new_value\"
//! \details Important! This event will be raised only with started
//! thread.