Ajout desc

This commit is contained in:
Serge NOEL
2026-02-13 09:28:40 +01:00
parent 758f73bc0e
commit d78e04366f
13 changed files with 619 additions and 44 deletions

View File

@@ -1,3 +1,54 @@
/**
* @file system.ino
* @brief System support functions for PacoMouseCYD throttle.
* @author F. Cañada
* @date 2025-2026
* @copyright https://usuaris.tinet.cat/fmco/
*
* This file contains functions for hardware initialization, backlight control,
* display rotation, and system-level utilities for the PacoMouseCYD throttle.
*/
////////////////////////////////////////////////////////////
// API Documentation
////////////////////////////////////////////////////////////
/**
* @brief Initializes all hardware pins and peripherals.
*/
void initPins();
/**
* @brief Sets the PWM backlight value.
* @param value The backlight intensity value.
*/
void setBacklight(uint8_t value);
/**
* @brief Rotates the display and touchscreen.
* @param pos The rotation position.
*/
void setRotationDisplay(uint8_t pos);
/**
* @brief Resets the inactivity timer and restores backlight if needed.
*/
void aliveAndKicking();
#if (USE_RGB_LED == PRESENT)
/**
* @brief Sets the color of the RGB LED.
* @param color The color value.
*/
void setColorRGB(uint16_t color);
#endif
// Add further function documentation here as needed for each public function.
////////////////////////////////////////////////////////////
// End API Documentation
////////////////////////////////////////////////////////////
/* PacoMouseCYD throttle -- F. Cañada 2025-2026 -- https://usuaris.tinet.cat/fmco/
*/