Camera_driver: Update doxygen documentation of camera driver

This commit is contained in:
Petr Malanik
2023-01-23 20:24:56 +01:00
parent d99e4b27e6
commit 9ce15191d3
7 changed files with 416 additions and 299 deletions

View File

@ -16,17 +16,44 @@
using namespace std;
typedef unsigned int uint;
/**
* @brief Captures image data from camera, control power to camera and transmit data on selected interfaces
* Currently is only UART interface supported
*/
class ButCube_imager
{
private:
/**
* @brief UART interfaces to which data will be exported, interfaces muse be configured in advance
*/
vector<UART_HandleTypeDef> uart_output_interfaces;
public:
/**
* @brief Construct a new ButCube_imager object
*/
ButCube_imager() = default;
/**
* @brief Add UART output to list on which data are exported
*
* @param uart_output UART output to which export data from camera
* @return int
*/
int Add_output(UART_HandleTypeDef uart_output);
/**
* @brief Transmit data from source to selected interfaces
*
* @param source Source of image data
* @return int Count of bytes exported
*/
int Transmit(vector<uint8_t> source);
/**
* @brief Enable or power to camera, controls load switch on camera power rail
*
* @param state true = Enabled, false = Disabled
*/
void Camera_power(bool state);
};