master.h

Go to the documentation of this file.

#ifndef LIGHTMODBUS_MASTER_H
#define LIGHTMODBUS_MASTER_H
 
#include <stdint.h>
#include <stddef.h>
#include "base.h"
 
typedef struct ModbusMaster ModbusMaster;
 
typedef ModbusErrorInfo (*ModbusResponseParsingFunction)(
    ModbusMaster *status,
    uint8_t address,
    uint8_t function,
    const uint8_t *requestPDU,
    uint8_t requestLength,
    const uint8_t *responsePDU,
    uint8_t responseLength);
 
typedef struct ModbusMasterFunctionHandler
{
    uint8_t id;
    ModbusResponseParsingFunction ptr;
} ModbusMasterFunctionHandler;
 
typedef struct ModbusDataCallbackArgs
{
    ModbusDataType type; 
    uint16_t index;      
    uint16_t value;      
    uint8_t function;    
    uint8_t address;     
} ModbusDataCallbackArgs;
 
typedef ModbusError (*ModbusDataCallback)(
    const ModbusMaster *status,
    const ModbusDataCallbackArgs *args);
 
typedef ModbusError (*ModbusMasterExceptionCallback)(
    const ModbusMaster *status,
    uint8_t address,
    uint8_t function,
    ModbusExceptionCode code);
 
struct ModbusMaster
{
    ModbusDataCallback dataCallback;                  
    ModbusMasterExceptionCallback exceptionCallback;  
 
    const ModbusMasterFunctionHandler *functions; 
    uint8_t functionCount; 
 
    ModbusBuffer request;
 
    void *context; 
};
 
LIGHTMODBUS_RET_ERROR modbusMasterInit(
    ModbusMaster *status,
    ModbusDataCallback dataCallback,
    ModbusMasterExceptionCallback exceptionCallback,
    ModbusAllocator allocator,
    const ModbusMasterFunctionHandler *functions,
    uint8_t functionCount);
 
void modbusMasterDestroy(ModbusMaster *status);
 
LIGHTMODBUS_RET_ERROR modbusBeginRequestPDU(ModbusMaster *status);
LIGHTMODBUS_RET_ERROR modbusEndRequestPDU(ModbusMaster *status);
LIGHTMODBUS_RET_ERROR modbusBeginRequestRTU(ModbusMaster *status);
LIGHTMODBUS_RET_ERROR modbusEndRequestRTU(ModbusMaster *status, uint8_t address);
LIGHTMODBUS_RET_ERROR modbusBeginRequestTCP(ModbusMaster *status);
LIGHTMODBUS_RET_ERROR modbusEndRequestTCP(ModbusMaster *status, uint16_t transaction, uint8_t unit);
 
LIGHTMODBUS_RET_ERROR modbusParseResponsePDU(
    ModbusMaster *status,
    uint8_t address,
    const uint8_t *request,
    uint8_t requestLength,
    const uint8_t *response,
    uint8_t responseLength);
 
LIGHTMODBUS_RET_ERROR modbusParseResponseRTU(
    ModbusMaster *status,
    const uint8_t *request,
    uint16_t requestLength,
    const uint8_t *response,
    uint16_t responseLength);
 
LIGHTMODBUS_RET_ERROR modbusParseResponseTCP(
    ModbusMaster *status,
    const uint8_t *request,
    uint16_t requestLength,
    const uint8_t *response,
    uint16_t responseLength);
 
LIGHTMODBUS_WARN_UNUSED static inline const uint8_t *modbusMasterGetRequest(const ModbusMaster *status)
{
    return status->request.data;
}
 
LIGHTMODBUS_WARN_UNUSED static inline uint16_t modbusMasterGetRequestLength(const ModbusMaster *status)
{
    return status->request.length;
}
 
static inline void modbusMasterSetUserPointer(ModbusMaster *status, void *ptr)
{
    status->context = ptr;
}
 
static inline void *modbusMasterGetUserPointer(const ModbusMaster *status)
{
    return status->context;
}
 
LIGHTMODBUS_WARN_UNUSED static inline ModbusError modbusMasterAllocateRequest(
    ModbusMaster *status,
    uint16_t pduSize)
{
    return modbusBufferAllocateADU(&status->request, pduSize, modbusMasterGetUserPointer(status));
}
 
static inline void modbusMasterFreeRequest(ModbusMaster *status)
{
    modbusBufferFree(&status->request, modbusMasterGetUserPointer(status));
}
 
extern ModbusMasterFunctionHandler modbusMasterDefaultFunctions[];
extern const uint8_t modbusMasterDefaultFunctionCount;
 
#endif