USART3.h

Go to the documentation of this file.

/*
    USART3.h - Functions and classes to use USART3 on AVR systems for
    serial I/O (includes buffering).
    For AVR ATMega2560 (Arduino Mega).
    This is part of the AVRTools library.
    Copyright (c) 2015 Igor Mikolic-Torreira.  All right reserved.
    Functions readlong() and readFloat() adapted from Arduino code that
    is Copyright (c) 2005-2006 David A. Mellis and licensed under LGPL.

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/


#if !defined(__AVR_ATmega2560__)
#error "USART3 doesn't exist on ATMega328p (Arduino Uno); you can only use this on ATMega2560 (Arduino Mega)."
#endif



#ifndef USART3_h
#define USART3_h

#include "Writer.h"
#include "Reader.h"

#include <stdint.h>
#include <stddef.h>


#ifndef USART_SERIAL_CONFIG
#define USART_SERIAL_CONFIG

enum UsartSerialConfiguration
{
    kSerial_5N1 = 0x00,     
    kSerial_6N1 = 0x02,     
    kSerial_7N1 = 0x04,     
    kSerial_8N1 = 0x06,     
    kSerial_5N2 = 0x08,     
    kSerial_6N2 = 0x0A,     
    kSerial_7N2 = 0x0C,     
    kSerial_8N2 = 0x0E,     
    kSerial_5E1 = 0x20,     
    kSerial_6E1 = 0x22,     
    kSerial_7E1 = 0x24,     
    kSerial_8E1 = 0x26,     
    kSerial_5E2 = 0x28,     
    kSerial_6E2 = 0x2A,     
    kSerial_7E2 = 0x2C,     
    kSerial_8E2 = 0x2E,     
    kSerial_5O1 = 0x30,     
    kSerial_6O1 = 0x32,     
    kSerial_7O1 = 0x34,     
    kSerial_8O1 = 0x36,     
    kSerial_5O2 = 0x38,     
    kSerial_6O2 = 0x3A,     
    kSerial_7O2 = 0x3C,     
    kSerial_8O2 = 0x3E      
};

#endif




namespace USART3
{

    void start( unsigned long baudRate, UsartSerialConfiguration config = kSerial_8N1 );


    void stop();



    size_t write( char c );


    size_t write( const char* c );


    size_t write( const char* c, size_t n );


    size_t write( const uint8_t* c, size_t n );


    void flush();


    int peek();


    int read();


    bool available();
};








class Serial3 : public Writer, public Reader
{
public:

    void start( unsigned long baudRate, UsartSerialConfiguration config = kSerial_8N1 )
    { USART3::start( baudRate, config ); }


    void stop()
    { USART3::stop(); }





    virtual size_t write( char c );

    virtual size_t write( const char* str );

    virtual size_t write( const char* buffer, size_t size );

    virtual size_t write( const uint8_t* buffer, size_t size );

    virtual void flush();



    // Virtual functions from Reader

    virtual int read();


    virtual int peek();


    virtual bool available();
};



#endif