include/nmtMaster.h
author etisserant
Tue, 01 Apr 2008 09:37:34 +0200
changeset 439 95052c784cb2
parent 71 95cd3376cc9f
child 528 0a30e161d63c
permissions -rw-r--r--
typo in states.c
/*
This file is part of CanFestival, a library implementing CanOpen Stack. 

Copyright (C): Edouard TISSERANT and Francis DUPIN

See COPYING file for copyrights details.

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

#ifndef __nmtMaster_h__
#define __nmtMaster_h__

#include "data.h"

/** Transmit a NMT message on the bus number bus_id
 * to the slave whose node_id is ID
 * bus_id is hardware dependant
 * cs represents the order of state changement:
 * cs =  NMT_Start_Node            // Put the node in operational mode             
 * cs =	 NMT_Stop_Node		   // Put the node in stopped mode
 * cs =	 NMT_Enter_PreOperational  // Put the node in pre_operational mode  
 * cs =  NMT_Reset_Node		   // Put the node in initialization mode 
 * cs =  NMT_Reset_Comunication	   // Put the node in initialization mode 
 * The mode is changed according to the slave state machine mode :
 *        initialisation  ---> pre-operational (Automatic transition)
 *        pre-operational <--> operational
 *        pre-operational <--> stopped
 *        pre-operational, operational, stopped -> initialisation
 *
 * return canSend(bus_id,&m)               
 */
UNS8 masterSendNMTstateChange (CO_Data* d, UNS8 Node_ID, UNS8 cs);

/** Transmit a Node_Guard message on the bus number bus_id
 * to the slave whose node_id is nodeId
 * bus_id is hardware dependant
 * return canSend(bus_id,&m)
 */
UNS8 masterSendNMTnodeguard (CO_Data* d, UNS8 nodeId);


/** Prepare a Node_Guard message transmission on the bus number bus_id
 * to the slave whose node_id is nodeId
 * Put nodeId = 0 to send an NMT broadcast.
 * This message will ask for the slave, whose node_id is nodeId, its state
 * bus_id is hardware dependant
 */
void masterRequestNodeState (CO_Data* d, UNS8 nodeId);


#endif /* __nmtMaster_h__ */