sw k / Mbed 2 deprecated Modbus

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed

Fork of Modbus by Matthew Waddilove

mbframe.h@1:a6730b74f48b, 2016-12-01 (annotated)

Committer:
swk
Date:
Thu Dec 01 00:56:19 2016 +0000
Revision:
1:a6730b74f48b
Parent:
0:274eb57e1df3 
dd

Who changed what in which revision?

UserRevisionLine numberNew contents of line
giryan 0:274eb57e1df3 1 /*
giryan 0:274eb57e1df3 2 * FreeModbus Libary: A portable Modbus implementation for Modbus ASCII/RTU.
giryan 0:274eb57e1df3 3 * Copyright (c) 2006 Christian Walter <wolti@sil.at>
giryan 0:274eb57e1df3 4 * All rights reserved.
giryan 0:274eb57e1df3 5 *
giryan 0:274eb57e1df3 6 * Redistribution and use in source and binary forms, with or without
giryan 0:274eb57e1df3 7 * modification, are permitted provided that the following conditions
giryan 0:274eb57e1df3 8 * are met:
giryan 0:274eb57e1df3 9 * 1. Redistributions of source code must retain the above copyright
giryan 0:274eb57e1df3 10 * notice, this list of conditions and the following disclaimer.
giryan 0:274eb57e1df3 11 * 2. Redistributions in binary form must reproduce the above copyright
giryan 0:274eb57e1df3 12 * notice, this list of conditions and the following disclaimer in the
giryan 0:274eb57e1df3 13 * documentation and/or other materials provided with the distribution.
giryan 0:274eb57e1df3 14 * 3. The name of the author may not be used to endorse or promote products
giryan 0:274eb57e1df3 15 * derived from this software without specific prior written permission.
giryan 0:274eb57e1df3 16 *
giryan 0:274eb57e1df3 17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
giryan 0:274eb57e1df3 18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
giryan 0:274eb57e1df3 19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
giryan 0:274eb57e1df3 20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
giryan 0:274eb57e1df3 21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
giryan 0:274eb57e1df3 22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
giryan 0:274eb57e1df3 23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
giryan 0:274eb57e1df3 24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
giryan 0:274eb57e1df3 25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
giryan 0:274eb57e1df3 26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
giryan 0:274eb57e1df3 27 *
giryan 0:274eb57e1df3 28 * File: $Id: mbframe.h,v 1.9 2006/12/07 22:10:34 wolti Exp $
giryan 0:274eb57e1df3 29 */
giryan 0:274eb57e1df3 30
giryan 0:274eb57e1df3 31 #ifndef _MB_FRAME_H
giryan 0:274eb57e1df3 32 #define _MB_FRAME_H
giryan 0:274eb57e1df3 33
giryan 0:274eb57e1df3 34 #ifdef __cplusplus
giryan 0:274eb57e1df3 35 PR_BEGIN_EXTERN_C
giryan 0:274eb57e1df3 36 #endif
giryan 0:274eb57e1df3 37
giryan 0:274eb57e1df3 38 /*!
giryan 0:274eb57e1df3 39 * Constants which defines the format of a modbus frame. The example is
giryan 0:274eb57e1df3 40 * shown for a Modbus RTU/ASCII frame. Note that the Modbus PDU is not
giryan 0:274eb57e1df3 41 * dependent on the underlying transport.
giryan 0:274eb57e1df3 42 *
giryan 0:274eb57e1df3 43 * <code>
giryan 0:274eb57e1df3 44 * <------------------------ MODBUS SERIAL LINE PDU (1) ------------------->
giryan 0:274eb57e1df3 45 * <----------- MODBUS PDU (1') ---------------->
giryan 0:274eb57e1df3 46 * +-----------+---------------+----------------------------+-------------+
giryan 0:274eb57e1df3 47 * | Address | Function Code | Data | CRC/LRC |
giryan 0:274eb57e1df3 48 * +-----------+---------------+----------------------------+-------------+
giryan 0:274eb57e1df3 49 * | | | |
giryan 0:274eb57e1df3 50 * (2) (3/2') (3') (4)
giryan 0:274eb57e1df3 51 *
giryan 0:274eb57e1df3 52 * (1) ... MB_SER_PDU_SIZE_MAX = 256
giryan 0:274eb57e1df3 53 * (2) ... MB_SER_PDU_ADDR_OFF = 0
giryan 0:274eb57e1df3 54 * (3) ... MB_SER_PDU_PDU_OFF = 1
giryan 0:274eb57e1df3 55 * (4) ... MB_SER_PDU_SIZE_CRC = 2
giryan 0:274eb57e1df3 56 *
giryan 0:274eb57e1df3 57 * (1') ... MB_PDU_SIZE_MAX = 253
giryan 0:274eb57e1df3 58 * (2') ... MB_PDU_FUNC_OFF = 0
giryan 0:274eb57e1df3 59 * (3') ... MB_PDU_DATA_OFF = 1
giryan 0:274eb57e1df3 60 * </code>
giryan 0:274eb57e1df3 61 */
giryan 0:274eb57e1df3 62
giryan 0:274eb57e1df3 63 /* ----------------------- Defines ------------------------------------------*/
giryan 0:274eb57e1df3 64 #define MB_PDU_SIZE_MAX 253 /*!< Maximum size of a PDU. */
giryan 0:274eb57e1df3 65 #define MB_PDU_SIZE_MIN 1 /*!< Function Code */
giryan 0:274eb57e1df3 66 #define MB_PDU_FUNC_OFF 0 /*!< Offset of function code in PDU. */
giryan 0:274eb57e1df3 67 #define MB_PDU_DATA_OFF 1 /*!< Offset for response data in PDU. */
giryan 0:274eb57e1df3 68
giryan 0:274eb57e1df3 69 /* ----------------------- Prototypes 0-------------------------------------*/
giryan 0:274eb57e1df3 70 typedef void ( *pvMBFrameStart ) ( void );
giryan 0:274eb57e1df3 71
giryan 0:274eb57e1df3 72 typedef void ( *pvMBFrameStop ) ( void );
giryan 0:274eb57e1df3 73
giryan 0:274eb57e1df3 74 typedef eMBErrorCode( *peMBFrameReceive ) ( UCHAR * pucRcvAddress,
giryan 0:274eb57e1df3 75 UCHAR ** pucFrame,
giryan 0:274eb57e1df3 76 USHORT * pusLength );
giryan 0:274eb57e1df3 77
giryan 0:274eb57e1df3 78 typedef eMBErrorCode( *peMBFrameSend ) ( UCHAR slaveAddress,
giryan 0:274eb57e1df3 79 const UCHAR * pucFrame,
giryan 0:274eb57e1df3 80 USHORT usLength );
giryan 0:274eb57e1df3 81
giryan 0:274eb57e1df3 82 typedef void( *pvMBFrameClose ) ( void );
giryan 0:274eb57e1df3 83
giryan 0:274eb57e1df3 84 #ifdef __cplusplus
giryan 0:274eb57e1df3 85 PR_END_EXTERN_C
giryan 0:274eb57e1df3 86 #endif
giryan 0:274eb57e1df3 87 #endif