HostPort.h

Go to the documentation of this file.

 
#ifndef _HOSTPORT_H
#define _HOSTPORT_H
 
#if ARDUINO >= 100
#include "Arduino.h"
#else
#include "WProgram.h"
#endif

 
//using constexpr instead
//#define BUF_SIZE 256 //size of buffers
//#define MAX_OBJS 3 //max num of attached objects
//#define MASK 0x000000FF //mask for bitwise operations
//#define TIMEOUT_HOSTPORT 500 //timeout (us)
 
class HostPort {
public:
    //constructors
    HostPort(Stream* serial, uint32_t header, uint32_t terminator); //constructor with both header and terminator

    HostPort(Stream* serial, uint32_t header); //constructor with header only

    HostPort(Stream* serial); //constructor w/o header and terminator
 
    //funs
    boolean attachRx(uint8_t* pointer, size_t size); //attach object for rx

    boolean attachTx(uint8_t* pointer, size_t size); //attach object for tx

    boolean write(); //write attached objects, return true if data written

    boolean read(); //read attached object, return true is data read
 
    //static constexpr
    static constexpr uint32_t NULL_HEADER = 0x00000000; 
    static constexpr uint32_t NULL_TERMINATOR = 0x00000000; 
    static constexpr uint32_t DEF_HEADER = 0xFF812345; 
    static constexpr uint32_t DEF_TERMINATOR = 0xFF8CABDE; 
 
private:
 
    //static constexpr
    static constexpr size_t BUF_SIZE = 256; 
    static constexpr size_t MAX_OBJS = 4; 
    static constexpr uint32_t MASK = 0x000000FF; 
    static constexpr uint32_t TIMEOUT_HOSTPORT = 500; 
 
    //funs
    void init(void); //general init in costructors

    void copyrx(void); //copy _rx_buf in _ptr_rx when reading was ok
 
    //vars
    uint8_t _rx_buf[BUF_SIZE] = { 0 }; 
    uint8_t _tx_buf[BUF_SIZE] = { 0 }; 
    uint32_t _header = NULL_HEADER; 
    uint32_t _terminator = NULL_TERMINATOR; 
    uint8_t* _ptr_rx[MAX_OBJS] = { nullptr }; 
    uint8_t* _ptr_tx[MAX_OBJS] = { nullptr }; 
    size_t _size_rx[MAX_OBJS] = { 0 }; 
    size_t _size_tx[MAX_OBJS] = { 0 }; 
    size_t _totSize_rx = 0; 
    size_t _totSize_tx = 0; 
    uint8_t _numObj_rx = 0; 
    uint8_t _numObj_tx = 0; 
    Stream* _serial = nullptr; 
};
 
#endif