Cam Marshall
Port of the FreeModbus Libary for mbed
mbconfig.h@0:0453a0a7e500, 2010-04-15 (annotated)
- Committer:
- cam
- Date:
- Thu Apr 15 12:10:34 2010 +0000
- Revision:
- 0:0453a0a7e500
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| cam | 0:0453a0a7e500 | 1 | /* |
| cam | 0:0453a0a7e500 | 2 | * FreeModbus Libary: A portable Modbus implementation for Modbus ASCII/RTU. |
| cam | 0:0453a0a7e500 | 3 | * Copyright (c) 2006 Christian Walter <wolti@sil.at> |
| cam | 0:0453a0a7e500 | 4 | * All rights reserved. |
| cam | 0:0453a0a7e500 | 5 | * |
| cam | 0:0453a0a7e500 | 6 | * Redistribution and use in source and binary forms, with or without |
| cam | 0:0453a0a7e500 | 7 | * modification, are permitted provided that the following conditions |
| cam | 0:0453a0a7e500 | 8 | * are met: |
| cam | 0:0453a0a7e500 | 9 | * 1. Redistributions of source code must retain the above copyright |
| cam | 0:0453a0a7e500 | 10 | * notice, this list of conditions and the following disclaimer. |
| cam | 0:0453a0a7e500 | 11 | * 2. Redistributions in binary form must reproduce the above copyright |
| cam | 0:0453a0a7e500 | 12 | * notice, this list of conditions and the following disclaimer in the |
| cam | 0:0453a0a7e500 | 13 | * documentation and/or other materials provided with the distribution. |
| cam | 0:0453a0a7e500 | 14 | * 3. The name of the author may not be used to endorse or promote products |
| cam | 0:0453a0a7e500 | 15 | * derived from this software without specific prior written permission. |
| cam | 0:0453a0a7e500 | 16 | * |
| cam | 0:0453a0a7e500 | 17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
| cam | 0:0453a0a7e500 | 18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
| cam | 0:0453a0a7e500 | 19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
| cam | 0:0453a0a7e500 | 20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
| cam | 0:0453a0a7e500 | 21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
| cam | 0:0453a0a7e500 | 22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| cam | 0:0453a0a7e500 | 23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| cam | 0:0453a0a7e500 | 24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| cam | 0:0453a0a7e500 | 25 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF |
| cam | 0:0453a0a7e500 | 26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| cam | 0:0453a0a7e500 | 27 | * |
| cam | 0:0453a0a7e500 | 28 | * File: $Id: mbconfig.h,v 1.14 2006/12/07 22:10:34 wolti Exp $ |
| cam | 0:0453a0a7e500 | 29 | */ |
| cam | 0:0453a0a7e500 | 30 | |
| cam | 0:0453a0a7e500 | 31 | #ifndef _MB_CONFIG_H |
| cam | 0:0453a0a7e500 | 32 | #define _MB_CONFIG_H |
| cam | 0:0453a0a7e500 | 33 | |
| cam | 0:0453a0a7e500 | 34 | #ifdef __cplusplus |
| cam | 0:0453a0a7e500 | 35 | PR_BEGIN_EXTERN_C |
| cam | 0:0453a0a7e500 | 36 | #endif |
| cam | 0:0453a0a7e500 | 37 | /* ----------------------- Defines ------------------------------------------*/ |
| cam | 0:0453a0a7e500 | 38 | /*! \defgroup modbus_cfg Modbus Configuration |
| cam | 0:0453a0a7e500 | 39 | * |
| cam | 0:0453a0a7e500 | 40 | * Most modules in the protocol stack are completly optional and can be |
| cam | 0:0453a0a7e500 | 41 | * excluded. This is specially important if target resources are very small |
| cam | 0:0453a0a7e500 | 42 | * and program memory space should be saved.<br> |
| cam | 0:0453a0a7e500 | 43 | * |
| cam | 0:0453a0a7e500 | 44 | * All of these settings are available in the file <code>mbconfig.h</code> |
| cam | 0:0453a0a7e500 | 45 | */ |
| cam | 0:0453a0a7e500 | 46 | /*! \addtogroup modbus_cfg |
| cam | 0:0453a0a7e500 | 47 | * @{ |
| cam | 0:0453a0a7e500 | 48 | */ |
| cam | 0:0453a0a7e500 | 49 | /*! \brief If Modbus ASCII support is enabled. */ |
| cam | 0:0453a0a7e500 | 50 | #define MB_ASCII_ENABLED ( 0 ) |
| cam | 0:0453a0a7e500 | 51 | /*! \brief If Modbus RTU support is enabled. */ |
| cam | 0:0453a0a7e500 | 52 | #define MB_RTU_ENABLED ( 1 ) |
| cam | 0:0453a0a7e500 | 53 | /*! \brief If Modbus TCP support is enabled. */ |
| cam | 0:0453a0a7e500 | 54 | #define MB_TCP_ENABLED ( 0 ) |
| cam | 0:0453a0a7e500 | 55 | /*! \brief The character timeout value for Modbus ASCII. |
| cam | 0:0453a0a7e500 | 56 | * |
| cam | 0:0453a0a7e500 | 57 | * The character timeout value is not fixed for Modbus ASCII and is therefore |
| cam | 0:0453a0a7e500 | 58 | * a configuration option. It should be set to the maximum expected delay |
| cam | 0:0453a0a7e500 | 59 | * time of the network. |
| cam | 0:0453a0a7e500 | 60 | */ |
| cam | 0:0453a0a7e500 | 61 | #define MB_ASCII_TIMEOUT_SEC ( 0 ) |
| cam | 0:0453a0a7e500 | 62 | /*! \brief Maximum number of Modbus functions codes the protocol stack |
| cam | 0:0453a0a7e500 | 63 | * should support. |
| cam | 0:0453a0a7e500 | 64 | * |
| cam | 0:0453a0a7e500 | 65 | * The maximum number of supported Modbus functions must be greater than |
| cam | 0:0453a0a7e500 | 66 | * the sum of all enabled functions in this file and custom function |
| cam | 0:0453a0a7e500 | 67 | * handlers. If set to small adding more functions will fail. |
| cam | 0:0453a0a7e500 | 68 | */ |
| cam | 0:0453a0a7e500 | 69 | #define MB_FUNC_HANDLERS_MAX ( 16 ) |
| cam | 0:0453a0a7e500 | 70 | /*! \brief Number of bytes which should be allocated for the <em>Report Slave ID |
| cam | 0:0453a0a7e500 | 71 | * </em>command. |
| cam | 0:0453a0a7e500 | 72 | * |
| cam | 0:0453a0a7e500 | 73 | * This number limits the maximum size of the additional segment in the |
| cam | 0:0453a0a7e500 | 74 | * report slave id function. See eMBSetSlaveID( ) for more information on |
| cam | 0:0453a0a7e500 | 75 | * how to set this value. It is only used if MB_FUNC_OTHER_REP_SLAVEID_ENABLED |
| cam | 0:0453a0a7e500 | 76 | * is set to <code>1</code>. |
| cam | 0:0453a0a7e500 | 77 | */ |
| cam | 0:0453a0a7e500 | 78 | #define MB_FUNC_OTHER_REP_SLAVEID_BUF ( 32 ) |
| cam | 0:0453a0a7e500 | 79 | /*! \brief If the <em>Report Slave ID</em> function should be enabled. */ |
| cam | 0:0453a0a7e500 | 80 | #define MB_FUNC_OTHER_REP_SLAVEID_ENABLED ( 1 ) |
| cam | 0:0453a0a7e500 | 81 | /*! \brief If the <em>Read Input Registers</em> function should be enabled. */ |
| cam | 0:0453a0a7e500 | 82 | #define MB_FUNC_READ_INPUT_ENABLED ( 1 ) |
| cam | 0:0453a0a7e500 | 83 | /*! \brief If the <em>Read Holding Registers</em> function should be enabled. */ |
| cam | 0:0453a0a7e500 | 84 | #define MB_FUNC_READ_HOLDING_ENABLED ( 1 ) |
| cam | 0:0453a0a7e500 | 85 | /*! \brief If the <em>Write Single Register</em> function should be enabled. */ |
| cam | 0:0453a0a7e500 | 86 | #define MB_FUNC_WRITE_HOLDING_ENABLED ( 1 ) |
| cam | 0:0453a0a7e500 | 87 | /*! \brief If the <em>Write Multiple registers</em> function should be enabled. */ |
| cam | 0:0453a0a7e500 | 88 | #define MB_FUNC_WRITE_MULTIPLE_HOLDING_ENABLED ( 1 ) |
| cam | 0:0453a0a7e500 | 89 | /*! \brief If the <em>Read Coils</em> function should be enabled. */ |
| cam | 0:0453a0a7e500 | 90 | #define MB_FUNC_READ_COILS_ENABLED ( 1 ) |
| cam | 0:0453a0a7e500 | 91 | /*! \brief If the <em>Write Coils</em> function should be enabled. */ |
| cam | 0:0453a0a7e500 | 92 | #define MB_FUNC_WRITE_COIL_ENABLED ( 1 ) |
| cam | 0:0453a0a7e500 | 93 | /*! \brief If the <em>Write Multiple Coils</em> function should be enabled. */ |
| cam | 0:0453a0a7e500 | 94 | #define MB_FUNC_WRITE_MULTIPLE_COILS_ENABLED ( 1 ) |
| cam | 0:0453a0a7e500 | 95 | /*! \brief If the <em>Read Discrete Inputs</em> function should be enabled. */ |
| cam | 0:0453a0a7e500 | 96 | #define MB_FUNC_READ_DISCRETE_INPUTS_ENABLED ( 1 ) |
| cam | 0:0453a0a7e500 | 97 | /*! \brief If the <em>Read/Write Multiple Registers</em> function should be enabled. */ |
| cam | 0:0453a0a7e500 | 98 | #define MB_FUNC_READWRITE_HOLDING_ENABLED ( 1 ) |
| cam | 0:0453a0a7e500 | 99 | /*! @} */ |
| cam | 0:0453a0a7e500 | 100 | #ifdef __cplusplus |
| cam | 0:0453a0a7e500 | 101 | PR_END_EXTERN_C |
| cam | 0:0453a0a7e500 | 102 | #endif |
| cam | 0:0453a0a7e500 | 103 | #endif |