include/lifegrd.h
changeset 529 c171e11707c5
parent 528 0a30e161d63c
child 635 30a0e926bb2e
equal deleted inserted replaced
528:0a30e161d63c 529:c171e11707c5
    18 You should have received a copy of the GNU Lesser General Public
    18 You should have received a copy of the GNU Lesser General Public
    19 License along with this library; if not, write to the Free Software
    19 License along with this library; if not, write to the Free Software
    20 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
    20 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
    21 */
    21 */
    22 
    22 
       
    23 /** @defgroup heartbeato Heartbeat Object
       
    24  *  The heartbeat mechanism for a device is established through cyclically transmitting a message by a
       
    25  *	heartbeat producer. One or more devices in the network are aware of this heartbeat message. If the
       
    26  *	heartbeat cycle fails for the heartbeat producer the local application on the heartbeat consumer will be
       
    27  *	informed about that event.
       
    28  *  @ingroup comobj
       
    29  */
       
    30 					 
    23 #ifndef __lifegrd_h__
    31 #ifndef __lifegrd_h__
    24 #define __lifegrd_h__
    32 #define __lifegrd_h__
    25 
    33 
    26 
    34 
    27 #include <applicfg.h>
    35 #include <applicfg.h>
    37 /*************************************************************************
    45 /*************************************************************************
    38  * Functions
    46  * Functions
    39  *************************************************************************/
    47  *************************************************************************/
    40 
    48 
    41 /** 
    49 /** 
       
    50  * @ingroup statemachine
    42  * @brief To read the state of a node
    51  * @brief To read the state of a node
    43  * This can be used by the master after having sent a life guard request,
    52  * This can be used by the master after having sent a life guard request,
    44  * of by any node if it is waiting for heartbeat.
    53  * of by any node if it is waiting for heartbeat.
    45  * @param *d Pointer on a CAN object data structure
    54  * @param *d Pointer on a CAN object data structure
    46  * @param nodeId Id of a node
    55  * @param nodeId Id of a node