TransactionSerial< rxBufSize > Struct Template Reference

#include <ModbusMaster.h>

Inheritance diagram for TransactionSerial< rxBufSize >:

Public Types
enum	Result : uint8_t { Result::success = 0x00, Result::timeout = 0xE0, Result::busy = 0xE1 }

Public Member Functions
void	attachPostTransmit (Callback< void()> f)
void	attachPreTransmit (Callback< void()> f)
void	rxCompleteHandler ()
void	rxHandler ()
void	setTimeout (std::chrono::milliseconds t)
void	timeoutHandler ()
void	transact (uint8_t *txBuf, int txLen, Callback< void(Result)> cb)
	TransactionSerial (EventQueue *queue, PinName txPin, PinName rxPin, int baud, std::chrono::microseconds frameDelim, std::chrono::milliseconds rxTimeout=50ms)

Public Attributes
Callback< void(Result)>	complete = NULL
std::chrono::microseconds	frameDelim
Timeout	frameTimeout
Callback< void()>	postTransmit = NULL
Callback< void()>	preTransmit = NULL
EventQueue *	queue
uint8_t	rxBuf [rxBufSize] = {}
size_t	rxIdx = 0
std::chrono::milliseconds	rxTimeout
int	timeoutEvent = 0
Semaphore	txnLock

Detailed Description

template<size_t rxBufSize>
struct TransactionSerial< rxBufSize >

Definition at line 5 of file ModbusMaster.h.

Member Enumeration Documentation

Result

template<size_t rxBufSize>

enum TransactionSerial::Result : uint8_t

strong

Enumerator
success
timeout
busy

Definition at line 6 of file ModbusMaster.h.

                       : uint8_t {
        success = 0x00,
        timeout = 0xE0,
        busy = 0xE1,
    };

Constructor & Destructor Documentation

TransactionSerial()

template<size_t rxBufSize>

TransactionSerial< rxBufSize >::TransactionSerial ( EventQueue *  queue, PinName  txPin, PinName  rxPin, int  baud, std::chrono::microseconds  frameDelim, std::chrono::milliseconds  rxTimeout = 50ms  )

inline

Definition at line 26 of file ModbusMaster.h.

        : SerialBase(txPin, rxPin, baud),
          queue(queue),
          txnLock(1, 1),
          rxTimeout(rxTimeout),
          frameDelim(frameDelim) {
    }

Member Function Documentation

attachPostTransmit()

template<size_t rxBufSize>

void TransactionSerial< rxBufSize >::attachPostTransmit ( Callback< void()>  f )

inline

Definition at line 42 of file ModbusMaster.h.

{ postTransmit = f; };

attachPreTransmit()

template<size_t rxBufSize>

void TransactionSerial< rxBufSize >::attachPreTransmit ( Callback< void()>  f )

inline

Definition at line 41 of file ModbusMaster.h.

{ preTransmit = f; };

rxCompleteHandler()

template<size_t rxBufSize>

void TransactionSerial< rxBufSize >::rxCompleteHandler ( )

inline

Definition at line 61 of file ModbusMaster.h.

                             {
        attach(NULL);
        queue->cancel(timeoutEvent);
        txnLock.release();
        complete(Result::success);
    }

rxHandler()

template<size_t rxBufSize>

void TransactionSerial< rxBufSize >::rxHandler ( )

inline

Definition at line 44 of file ModbusMaster.h.

                     {
        if(!readable()) return;
        if(rxIdx >= rxBufSize) rxIdx = 0;
        lock();
        rxBuf[rxIdx++] = _base_getc();
        unlock();
        frameTimeout.attach([this]() {
            queue->call([this]() {
                if(txnLock.try_acquire()) { // Guard rx outside txn
                    txnLock.release();
                    return;
                }
                rxCompleteHandler();
            });
        }, frameDelim);
    }

setTimeout()

template<size_t rxBufSize>

void TransactionSerial< rxBufSize >::setTimeout ( std::chrono::milliseconds  t )

inline

Definition at line 40 of file ModbusMaster.h.

{ rxTimeout = t; };

timeoutHandler()

template<size_t rxBufSize>

void TransactionSerial< rxBufSize >::timeoutHandler ( )

inline

Definition at line 68 of file ModbusMaster.h.

                          {
        attach(NULL);
        frameTimeout.detach();
        txnLock.release();
        complete(Result::timeout);
    }

transact()

template<size_t rxBufSize>

void TransactionSerial< rxBufSize >::transact ( uint8_t *  txBuf, int  txLen, Callback< void(Result)>  cb  )

inline

Definition at line 75 of file ModbusMaster.h.

                                                                        {
        if (!txnLock.try_acquire()) return cb(Result::busy);
        rxIdx = 0;
        complete = cb;
        timeoutEvent = queue->call_in(rxTimeout, [this]() { timeoutHandler(); });
        if (preTransmit) preTransmit();
        write(txBuf, txLen, [this](int e){
            attach([this](){ rxHandler(); });
            if(postTransmit) queue->call(postTransmit);
        }, SERIAL_EVENT_TX_COMPLETE);
    }

Member Data Documentation

complete

template<size_t rxBufSize>

Callback<void(Result)> TransactionSerial< rxBufSize >::complete = NULL

Definition at line 24 of file ModbusMaster.h.

frameDelim

template<size_t rxBufSize>

std::chrono::microseconds TransactionSerial< rxBufSize >::frameDelim

Definition at line 17 of file ModbusMaster.h.

frameTimeout

template<size_t rxBufSize>

Timeout TransactionSerial< rxBufSize >::frameTimeout

Definition at line 14 of file ModbusMaster.h.

postTransmit

template<size_t rxBufSize>

Callback<void()> TransactionSerial< rxBufSize >::postTransmit = NULL

Definition at line 23 of file ModbusMaster.h.

preTransmit

template<size_t rxBufSize>

Callback<void()> TransactionSerial< rxBufSize >::preTransmit = NULL

Definition at line 22 of file ModbusMaster.h.

queue

template<size_t rxBufSize>

EventQueue* TransactionSerial< rxBufSize >::queue

Definition at line 12 of file ModbusMaster.h.

rxBuf

template<size_t rxBufSize>

uint8_t TransactionSerial< rxBufSize >::rxBuf[rxBufSize] = {}

Definition at line 19 of file ModbusMaster.h.

rxIdx

template<size_t rxBufSize>

size_t TransactionSerial< rxBufSize >::rxIdx = 0

Definition at line 18 of file ModbusMaster.h.

rxTimeout

template<size_t rxBufSize>

std::chrono::milliseconds TransactionSerial< rxBufSize >::rxTimeout

Definition at line 16 of file ModbusMaster.h.

timeoutEvent

template<size_t rxBufSize>

int TransactionSerial< rxBufSize >::timeoutEvent = 0

Definition at line 20 of file ModbusMaster.h.

txnLock

template<size_t rxBufSize>

Semaphore TransactionSerial< rxBufSize >::txnLock

Definition at line 13 of file ModbusMaster.h.

---

The documentation for this struct was generated from the following file:

• ModbusMaster.h