Software UART program using Infra-Red LED and IR-Detector

Dependents:   TestVirtualisation Bf_SoftSerial_IR

SoftSerial_IR.h

Committer:
kenjiArai
Date:
2020-05-15
Revision:
15:8d343be3382d
Parent:
14:dc766032cdd6

File content as of revision 15:8d343be3382d:

/*
    Original Library by Erik- & SonyPony
    https://os.mbed.com/users/Sissors/code/SoftSerial/

    Modified by K.Arai / JH1PJL     May 15th, 2020

    modified functions
        tx_handler()
        prepare_tx()
        prime()
        rx_gpio_irq_handler() and others
 */

#ifndef SOFTSERIAL_IR_H
#define SOFTSERIAL_IR_H

#include "mbed.h"
#include "SoftSerial_Ticker_IR.h"

#define DEBUG_TIMING    2   // 0=no debug, 1=tx, 2=rx

#if (MBED_MAJOR_VERSION == 2)
#   define  YIELD   {;}
#elif (MBED_MAJOR_VERSION == 5)
#   define  YIELD   {ThisThread::yield();}
#endif

/** A software serial implementation
 *
 */
class SoftSerial_IR: public Stream
{

public:
    /**
    * Constructor
    *
    * @param TX Name of the TX pin, NC for not connected
    * @param RX Name of the RX pin, NC for not connected,
    *        must be capable of being InterruptIn
    * @param name Name of the connection
    */
    SoftSerial_IR(PinName TX, PinName RX, const char* name = NULL);
    virtual ~SoftSerial_IR();

    /** Set the baud rate of the serial port
     *
     *  @param baudrate The baudrate of the serial port (default = 2400).
     */
    void baud(int baudrate);

    enum Parity {
        None = 0,
        Odd,
        Even,
        Forced1,
        Forced0
    };

    enum IrqType {
        RxIrq = 0,
        TxIrq
    };

    /** Set the transmission format used by the serial port
     *
     *  @param bits The number of bits in a word (default = 8)
     *  @param parity The parity used
     *   (SoftSerial_IR::None, SoftSerial_IR::Odd, SoftSerial_IR::Even,
     *   SoftSerial_IR::Forced1, SoftSerial_IR::Forced0;
     *   default = SoftSerial_IR::None)
     *  @param stop The number of stop bits (default = 1)
     */
    void format(int bits=8, Parity parity=SoftSerial_IR::None, int stop_bits=1);

    /** Determine if there is a character available to read
     *
     *  @returns
     *    1 if there is a character available to read,
     *    0 otherwise
     */
    int readable();

    /** Determine if there is space available to write a character
     *
     *  @returns
     *    1 if there is space to write a character,
     *    0 otherwise
     */
    int writeable();

    /** Attach a function to call whenever a serial interrupt is generated
     *
     *  @param fptr A pointer to a void function, or 0 to set as none
     *  @param type Which serial interrupt to attach the member function
     *       to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty)
     */
    void attach(void (*fptr)(void), IrqType type=RxIrq)
    {
        fpointer[type] = Callback<void()>(fptr);
    }

    /** Attach a member function to call
     *      whenever a serial interrupt is generated
     *
     *  @param tptr pointer to the object to call the member function on
     *  @param mptr pointer to the member function to be called
     *  @param type Which serial interrupt to attach the member function
     *       to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty)
     */
    template<typename T>
    void attach(T* tptr, void (T::*mptr)(void), IrqType type=RxIrq)
    {
        fpointer[type] = Callback<void()>(tptr, mptr);
    }

    /** Generate a break condition on the serial line
     */
    void send_break();

protected:
    //DigitalOut *tx;
    PwmOut *tx;
    InterruptIn *rx;

    bool tx_en, rx_en;
    int bit_period;
    int _bits, _stop_bits, _total_bits;
    Parity _parity;

    Callback<void()>  fpointer[2];

    //rx
    void rx_gpio_irq_handler(void);
    void rx_handler(void);
    int read_buffer, rx_bit;
    volatile int out_buffer;
    volatile bool out_valid;
    bool rx_error;
    FlexTicker rxticker;

    bool rx_1st;
    uint32_t rx_st_time;

    //tx
    void tx_handler(void);
    void prepare_tx(int c);
    FlexTicker txticker;
    int _char;
    volatile int tx_bit;

    virtual int _getc();
    virtual int _putc(int c);
};

#endif