sdoc.h

This library is Copyright (c) Raphael Zulliger <[e-mail]>. It is licensed under the GNU L

/***************************************************************************
                          sdoc.h  -  description
                             -------------------
    begin                : Fri May 17 2002
    copyright            : (C) 2002 by Raphael Zulliger
    email                : [e-mail]
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This library is Copyright (c) Raphael Zulliger <[e-mail]>.       *
 *   It is licensed under the GNU Library General Public License (LGPL).   *
 *                                                                         *
 ***************************************************************************/


/** \file
 *  \brief Functions for accessing object dictionary of this device by
 *         other devices.
 *
 *   SDO client related functions. They are used for accessing a slave
 *   modules object dictionary
 *   \warning No functions are implemented yet, because SDO transfer hasn't been
 *            implemented yet. Feel free to implement it ;-) (you can more or
 *            less copy the needed source from CanFestival at
 *            http://canfestival.sourceforge.net - thanks to Edouard Tisserant)
 */

#ifndef __sdoc_h__
#define __sdoc_h__

/** this function is called by proccessRxCanMessages. it is responsible for proccessing
 *  SDO messages. e.g. if the server wants to read/write an entry in the Object
 *  dictionary
 *  \param canopenMessage Contains the CAN-Message that has been received by this device.
 */
void processReceivedSDO( s_rx_buffer_message* canopenMessage );

/** A remote node can call this function (by SDO) to save the state of the Object
 *  dictionary into a persistend memory (EEProm, Flash, ...). the argument 
 *  indicates which subindex is called (different subindicies stands for different
 *  save-options. see standard)
 */
void saveOD( BYTE bSubindex );

/** A remote node can call this function (by SDO) to load the standard Object
 *  dictionary (OD) from a persistent memore (EEProm, Flash, ...). This is useful, if
 *  the OD has been modified, but you want to undo this changes. the argument 
 *  indicates which subindex is called (different subindicies stands for different
 *  load-options. see standard)
 */
void loadOD( BYTE bSubindex );

#define COUNT_SDO_CLIENT  3   // !!!! this value must be same as available SDO clients in the Object directory.

#endif // __sdoc_h__