Ajout desc
This commit is contained in:
@@ -1,13 +1,60 @@
|
||||
|
||||
/**
|
||||
* @file xnet.ino
|
||||
* @brief XpressNet LAN protocol support for PacoMouseCYD throttle.
|
||||
* @author F. Cañada
|
||||
* @date 2025-2026
|
||||
* @copyright https://usuaris.tinet.cat/fmco/
|
||||
*
|
||||
* This file contains functions for handling XpressNet LAN protocol operations,
|
||||
* error handling, and communication with command stations 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.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED.
|
||||
*
|
||||
* 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 Shows error states for XpressNet LAN and updates UI accordingly.
|
||||
*/
|
||||
void showErrorXnet();
|
||||
|
||||
/**
|
||||
* @brief Shows normal operation state for XpressNet LAN and updates UI accordingly.
|
||||
*/
|
||||
void showNormalOpsXnet();
|
||||
|
||||
/**
|
||||
* @brief Computes the XpressNet address, handling long addresses.
|
||||
* @param adr The input address.
|
||||
* @return The computed XpressNet address.
|
||||
*/
|
||||
uint16_t addrXnet(uint16_t adr);
|
||||
|
||||
// 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/
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED.
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED.
|
||||
|
||||
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.
|
||||
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.
|
||||
*/
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user