mbconfig.h

00001 /* 
00002  * FreeModbus Libary: A portable Modbus implementation for Modbus ASCII/RTU.
00003  * Copyright (c) 2006 Christian Walter <wolti@sil.at>
00004  * All rights reserved.
00005  *
00006  * Redistribution and use in source and binary forms, with or without
00007  * modification, are permitted provided that the following conditions
00008  * are met:
00009  * 1. Redistributions of source code must retain the above copyright
00010  *    notice, this list of conditions and the following disclaimer.
00011  * 2. Redistributions in binary form must reproduce the above copyright
00012  *    notice, this list of conditions and the following disclaimer in the
00013  *    documentation and/or other materials provided with the distribution.
00014  * 3. The name of the author may not be used to endorse or promote products
00015  *    derived from this software without specific prior written permission.
00016  *
00017  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
00018  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00019  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
00020  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
00021  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
00022  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
00023  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
00024  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00025  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
00026  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00027  *
00028  * File: $Id: mbconfig.h,v 1.15 2010/06/06 13:54:40 wolti Exp $
00029  */
00030 
00031 #ifndef _MB_CONFIG_H
00032 #define _MB_CONFIG_H
00033 
00034 #ifdef __cplusplus
00035 PR_BEGIN_EXTERN_C
00036 #endif
00037 /* ----------------------- Defines ------------------------------------------*/
00038 /*! \defgroup modbus_cfg Modbus Configuration
00039  *
00040  * Most modules in the protocol stack are completly optional and can be
00041  * excluded. This is specially important if target resources are very small
00042  * and program memory space should be saved.<br>
00043  *
00044  * All of these settings are available in the file <code>mbconfig.h</code>
00045  */
00046 /*! \addtogroup modbus_cfg
00047  *  @{
00048  */
00049 /*! \brief If Modbus ASCII support is enabled. */
00050 #define MB_ASCII_ENABLED                        (  0 )
00051 
00052 /*! \brief If Modbus RTU support is enabled. */
00053 #define MB_RTU_ENABLED                          (  0 )
00054 
00055 /*! \brief If Modbus TCP support is enabled. */
00056 #define MB_TCP_ENABLED                          (  1 )
00057 
00058 /*! \brief The character timeout value for Modbus ASCII.
00059  *
00060  * The character timeout value is not fixed for Modbus ASCII and is therefore
00061  * a configuration option. It should be set to the maximum expected delay
00062  * time of the network.
00063  */
00064 #define MB_ASCII_TIMEOUT_SEC                    (  1 )
00065 
00066 /*! \brief Timeout to wait in ASCII prior to enabling transmitter.
00067  *
00068  * If defined the function calls vMBPortSerialDelay with the argument
00069  * MB_ASCII_TIMEOUT_WAIT_BEFORE_SEND_MS to allow for a delay before
00070  * the serial transmitter is enabled. This is required because some
00071  * targets are so fast that there is no time between receiving and
00072  * transmitting the frame. If the master is to slow with enabling its 
00073  * receiver then he will not receive the response correctly.
00074  */
00075 #ifndef MB_ASCII_TIMEOUT_WAIT_BEFORE_SEND_MS
00076 #define MB_ASCII_TIMEOUT_WAIT_BEFORE_SEND_MS    ( 0 )
00077 #endif
00078 
00079 /*! \brief Maximum number of Modbus functions codes the protocol stack
00080  *    should support.
00081  *
00082  * The maximum number of supported Modbus functions must be greater than
00083  * the sum of all enabled functions in this file and custom function
00084  * handlers. If set to small adding more functions will fail.
00085  */
00086 #define MB_FUNC_HANDLERS_MAX                    ( 16 )
00087 
00088 /*! \brief Number of bytes which should be allocated for the <em>Report Slave ID
00089  *    </em>command.
00090  *
00091  * This number limits the maximum size of the additional segment in the
00092  * report slave id function. See eMBSetSlaveID(  ) for more information on
00093  * how to set this value. It is only used if MB_FUNC_OTHER_REP_SLAVEID_ENABLED
00094  * is set to <code>1</code>.
00095  */
00096 #define MB_FUNC_OTHER_REP_SLAVEID_BUF           ( 32 )
00097 
00098 /*! \brief If the <em>Report Slave ID</em> function should be enabled. */
00099 #define MB_FUNC_OTHER_REP_SLAVEID_ENABLED       (  1 )
00100 
00101 /*! \brief If the <em>Read Input Registers</em> function should be enabled. */
00102 #define MB_FUNC_READ_INPUT_ENABLED              (  1 )
00103 
00104 /*! \brief If the <em>Read Holding Registers</em> function should be enabled. */
00105 #define MB_FUNC_READ_HOLDING_ENABLED            (  1 )
00106 
00107 /*! \brief If the <em>Write Single Register</em> function should be enabled. */
00108 #define MB_FUNC_WRITE_HOLDING_ENABLED           (  1 )
00109 
00110 /*! \brief If the <em>Write Multiple registers</em> function should be enabled. */
00111 #define MB_FUNC_WRITE_MULTIPLE_HOLDING_ENABLED  (  1 )
00112 
00113 /*! \brief If the <em>Read Coils</em> function should be enabled. */
00114 #define MB_FUNC_READ_COILS_ENABLED              (  1 )
00115 
00116 /*! \brief If the <em>Write Coils</em> function should be enabled. */
00117 #define MB_FUNC_WRITE_COIL_ENABLED              (  1 )
00118 
00119 /*! \brief If the <em>Write Multiple Coils</em> function should be enabled. */
00120 #define MB_FUNC_WRITE_MULTIPLE_COILS_ENABLED    (  1 )
00121 
00122 /*! \brief If the <em>Read Discrete Inputs</em> function should be enabled. */
00123 #define MB_FUNC_READ_DISCRETE_INPUTS_ENABLED    (  1 )
00124 
00125 /*! \brief If the <em>Read/Write Multiple Registers</em> function should be enabled. */
00126 #define MB_FUNC_READWRITE_HOLDING_ENABLED       (  1 )
00127 
00128 /*! @} */
00129 #ifdef __cplusplus
00130     PR_END_EXTERN_C
00131 #endif
00132 #endif