mirror of
https://git.intern.spaceteamaachen.de/ALPAKA/sta-core.git
synced 2025-08-06 10:27:34 +00:00
Updated: Doxygen Documentation
This commit is contained in:
committed by
CarlWachter
parent
b3ed26e288
commit
16b9e6135c
@@ -19,6 +19,11 @@ namespace sta
|
||||
class I2C : public Interface
|
||||
{
|
||||
public:
|
||||
/**
|
||||
* @brief Construct a new %I2C object.
|
||||
*
|
||||
* @param mutex Mutex object for managing shared access. Pass nullptr for no access control.
|
||||
*/
|
||||
I2C(Mutex * mutex=nullptr);
|
||||
|
||||
/**
|
||||
@@ -31,8 +36,11 @@ namespace sta
|
||||
void setSettings(uint16_t address, bool master, bool blocking);
|
||||
|
||||
protected:
|
||||
/// @brief The peripheral's address to communicate with.
|
||||
uint16_t address_;
|
||||
/// @brief Whether the mcu is a master or slave.
|
||||
bool master_;
|
||||
/// @brief Whether to use blocking or non-blocking transmits / receives.
|
||||
bool blocking_;
|
||||
};
|
||||
} // namespace sta
|
||||
|
Reference in New Issue
Block a user