Statistics
| Branch: | Revision:

root / freemodbus / modbus / include / mbconfig.h @ 20e5429c

History | View | Annotate | Download (5.54 KB)

1
/* 
2
 * FreeModbus Libary: A portable Modbus implementation for Modbus ASCII/RTU.
3
 * Copyright (c) 2006 Christian Walter <wolti@sil.at>
4
 * All rights reserved.
5
 *
6
 * Redistribution and use in source and binary forms, with or without
7
 * modification, are permitted provided that the following conditions
8
 * are met:
9
 * 1. Redistributions of source code must retain the above copyright
10
 *    notice, this list of conditions and the following disclaimer.
11
 * 2. Redistributions in binary form must reproduce the above copyright
12
 *    notice, this list of conditions and the following disclaimer in the
13
 *    documentation and/or other materials provided with the distribution.
14
 * 3. The name of the author may not be used to endorse or promote products
15
 *    derived from this software without specific prior written permission.
16
 *
17
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27
 *
28
 * File: $Id: mbconfig.h,v 1.15 2010/06/06 13:54:40 wolti Exp $
29
 */
30

    
31
#ifndef _MB_CONFIG_H
32
#define _MB_CONFIG_H
33

    
34
#ifdef __cplusplus
35
PR_BEGIN_EXTERN_C
36
#endif
37
/* ----------------------- Defines ------------------------------------------*/
38
/*! \defgroup modbus_cfg Modbus Configuration
39
 *
40
 * Most modules in the protocol stack are completly optional and can be
41
 * excluded. This is specially important if target resources are very small
42
 * and program memory space should be saved.<br>
43
 *
44
 * All of these settings are available in the file <code>mbconfig.h</code>
45
 */
46
/*! \addtogroup modbus_cfg
47
 *  @{
48
 */
49
/*! \brief If Modbus ASCII support is enabled. */
50
#define MB_ASCII_ENABLED                        (  1 )
51

    
52
/*! \brief If Modbus RTU support is enabled. */
53
#define MB_RTU_ENABLED                          (  1 )
54

    
55
/*! \brief If Modbus TCP support is enabled. */
56
#define MB_TCP_ENABLED                          (  0 )
57

    
58
/*! \brief The character timeout value for Modbus ASCII.
59
 *
60
 * The character timeout value is not fixed for Modbus ASCII and is therefore
61
 * a configuration option. It should be set to the maximum expected delay
62
 * time of the network.
63
 */
64
#define MB_ASCII_TIMEOUT_SEC                    (  1 )
65

    
66
/*! \brief Timeout to wait in ASCII prior to enabling transmitter.
67
 *
68
 * If defined the function calls vMBPortSerialDelay with the argument
69
 * MB_ASCII_TIMEOUT_WAIT_BEFORE_SEND_MS to allow for a delay before
70
 * the serial transmitter is enabled. This is required because some
71
 * targets are so fast that there is no time between receiving and
72
 * transmitting the frame. If the master is to slow with enabling its 
73
 * receiver then he will not receive the response correctly.
74
 */
75
#ifndef MB_ASCII_TIMEOUT_WAIT_BEFORE_SEND_MS
76
#define MB_ASCII_TIMEOUT_WAIT_BEFORE_SEND_MS    ( 0 )
77
#endif
78

    
79
/*! \brief Maximum number of Modbus functions codes the protocol stack
80
 *    should support.
81
 *
82
 * The maximum number of supported Modbus functions must be greater than
83
 * the sum of all enabled functions in this file and custom function
84
 * handlers. If set to small adding more functions will fail.
85
 */
86
#define MB_FUNC_HANDLERS_MAX                    ( 16 )
87

    
88
/*! \brief Number of bytes which should be allocated for the <em>Report Slave ID
89
 *    </em>command.
90
 *
91
 * This number limits the maximum size of the additional segment in the
92
 * report slave id function. See eMBSetSlaveID(  ) for more information on
93
 * how to set this value. It is only used if MB_FUNC_OTHER_REP_SLAVEID_ENABLED
94
 * is set to <code>1</code>.
95
 */
96
#define MB_FUNC_OTHER_REP_SLAVEID_BUF           ( 32 )
97

    
98
/*! \brief If the <em>Report Slave ID</em> function should be enabled. */
99
#define MB_FUNC_OTHER_REP_SLAVEID_ENABLED       (  1 )
100

    
101
/*! \brief If the <em>Read Input Registers</em> function should be enabled. */
102
#define MB_FUNC_READ_INPUT_ENABLED              (  1 )
103

    
104
/*! \brief If the <em>Read Holding Registers</em> function should be enabled. */
105
#define MB_FUNC_READ_HOLDING_ENABLED            (  1 )
106

    
107
/*! \brief If the <em>Write Single Register</em> function should be enabled. */
108
#define MB_FUNC_WRITE_HOLDING_ENABLED           (  1 )
109

    
110
/*! \brief If the <em>Write Multiple registers</em> function should be enabled. */
111
#define MB_FUNC_WRITE_MULTIPLE_HOLDING_ENABLED  (  1 )
112

    
113
/*! \brief If the <em>Read Coils</em> function should be enabled. */
114
#define MB_FUNC_READ_COILS_ENABLED              (  1 )
115

    
116
/*! \brief If the <em>Write Coils</em> function should be enabled. */
117
#define MB_FUNC_WRITE_COIL_ENABLED              (  1 )
118

    
119
/*! \brief If the <em>Write Multiple Coils</em> function should be enabled. */
120
#define MB_FUNC_WRITE_MULTIPLE_COILS_ENABLED    (  1 )
121

    
122
/*! \brief If the <em>Read Discrete Inputs</em> function should be enabled. */
123
#define MB_FUNC_READ_DISCRETE_INPUTS_ENABLED    (  1 )
124

    
125
/*! \brief If the <em>Read/Write Multiple Registers</em> function should be enabled. */
126
#define MB_FUNC_READWRITE_HOLDING_ENABLED       (  1 )
127

    
128
/*! @} */
129
#ifdef __cplusplus
130
    PR_END_EXTERN_C
131
#endif
132
#endif