Ajout desc
This commit is contained in:
@@ -1,6 +1,14 @@
|
||||
|
||||
/**
|
||||
* PacoMouseCYD throttle -- F. Cañada 2025-2026 -- https://usuaris.tinet.cat/fmco/
|
||||
*
|
||||
* @file z21.ino
|
||||
* @brief Z21 protocol support for PacoMouseCYD throttle.
|
||||
* @author F. Cañada
|
||||
* @date 2025-2026
|
||||
* @copyright https://usuaris.tinet.cat/fmco/
|
||||
*
|
||||
* This file contains functions for Z21 protocol operations, including reading and writing CVs,
|
||||
* sending commands, and handling Z21-specific communication for the PacoMouseCYD throttle.
|
||||
*
|
||||
* This software and associated files are a DIY project that is not intended for commercial use.
|
||||
* This software uses libraries with different licenses, follow all their different terms included.
|
||||
*
|
||||
@@ -9,8 +17,31 @@
|
||||
* Sources are only provided for building and uploading to the device.
|
||||
* You are not allowed to modify the source code or fork/publish this project.
|
||||
* Commercial use is forbidden.
|
||||
*
|
||||
**/
|
||||
*/
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
// API Documentation
|
||||
////////////////////////////////////////////////////////////
|
||||
/**
|
||||
* @brief Reads a CV value from the Z21 command station.
|
||||
* @param adr The CV address to read.
|
||||
* @param stepPrg Programming step.
|
||||
*/
|
||||
void readCVZ21(unsigned int adr, byte stepPrg);
|
||||
|
||||
/**
|
||||
* @brief Writes a CV value to the Z21 command station.
|
||||
* @param adr The CV address to write.
|
||||
* @param data The data to write.
|
||||
* @param stepPrg Programming step.
|
||||
*/
|
||||
void writeCVZ21(unsigned int adr, unsigned int data, byte stepPrg);
|
||||
|
||||
// Add further function documentation here as needed for each public function.
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
// End API Documentation
|
||||
////////////////////////////////////////////////////////////
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user