--- a/include/sync.h Thu Nov 20 07:51:14 2008 +0100
+++ b/include/sync.h Sat Jan 17 17:25:58 2009 +0100
@@ -20,6 +20,12 @@
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
+/** @defgroup synco Synchronisation Object
+ * SYNC object is a CANopen message forcing the receiving nodes to sample the inputs mapped into synchronous TPDOS.
+ * Receiving this message causse the node to set the outputs to values received in the previous synchronous RPDO.
+ * @ingroup comobj
+ */
+
#ifndef __SYNC_h__
#define __SYNC_h__
@@ -33,18 +39,29 @@
typedef void (*post_TPDO_t)(CO_Data*);
void _post_TPDO(CO_Data* d);
-/** transmit a SYNC message and trigger sync TPDOs
+/**
+ * @ingroup synco
+ * @brief Transmit a SYNC message and trigger sync TPDOs
+ * @param *d Pointer on a CAN object data structure
+ * @return
*/
UNS8 sendSYNC (CO_Data* d);
-/** transmit a SYNC message on CAN bus
+
+/**
+ * @ingroup synco
+ * @brief Transmit a SYNC message on CAN bus
+ * @param *d Pointer on a CAN object data structure
+ * @return
*/
UNS8 sendSYNCMessage(CO_Data* d);
-/** This function is called when the node is receiving a SYNC message (cob-id = 0x80).
- * - check if the node is in OERATIONAL mode. (other mode : return 0 but does nothing).
+/**
+ * @brief This function is called when the node is receiving a SYNC message (cob-id = 0x80).
+ * - Check if the node is in OERATIONAL mode. (other mode : return 0 but does nothing).
* - Get the SYNC cobId by reading the dictionary index 1005, check it does correspond to the received cobId
* - Trigger sync TPDO emission
- * - return 0 if OK, 0xFF if error
+ * @param *d Pointer on a CAN object data structure
+ * @return 0 if OK, 0xFF if error
*/
UNS8 proceedSYNC (CO_Data* d);