OutputSerialUart.hpp

Go to the documentation of this file.

#pragma once
/******************************************************************
*
*       Project: ESPixelStick - An ESP8266 / ESP32 and E1.31 based pixel (And Serial!) driver
*       Orginal ESPixelStickproject by 2015 - 2025 Shelby Merrick
*
*This program is free software: you can redistribute it and/or modify it under the terms of the GNU 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 General Public License for more details.
<http://www.gnu.org/licenses/>
*
*This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License.
*To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/3.0/ or
*send a letter to Creative Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.
******************************************************************
*
*   This is a derived class that converts data in the output buffer into
*   serial channel intensities and then transmits them through the configured serial
*   interface.
*
*/
#include "ESPixelStick.h"
 
#if defined(SUPPORT_OutputProtocol_FireGod) || defined(SUPPORT_OutputProtocol_DMX) || defined(SUPPORT_OutputProtocol_Serial) || defined(SUPPORT_OutputProtocol_Renard)
 
#include "OutputSerial.hpp"
#include "OutputUart.hpp"
 
class c_OutputSerialUart : public c_OutputSerial
{
public:
    // These functions are inherited from c_OutputCommon
    c_OutputSerialUart (OM_OutputPortDefinition_t & OutputPortDefinition,
                        c_OutputMgr::e_OutputProtocolType outputType);
    virtual ~c_OutputSerialUart ();
 
    // functions to be provided by the derived class
    void            Begin ();                                         
    virtual bool    SetConfig(ArduinoJson::JsonObject &jsonConfig); 
    virtual void    GetConfig(ArduinoJson::JsonObject &jsonConfig); 
    virtual void    GetStatus(ArduinoJson::JsonObject &jsonStatus);
    uint32_t        Poll();
#if defined(ARDUINO_ARCH_ESP32)
    bool            RmtPoll () {return false;}
#endif // defined(ARDUINO_ARCH_ESP32)
    void            PauseOutput (bool NewState);
 
private:
    c_OutputUart Uart;
 
}; // c_OutputSerialUart
 
#endif // defined(SUPPORT_OutputProtocol_FireGod) || defined(SUPPORT_OutputProtocol_DMX) || defined(SUPPORT_OutputProtocol_Serial) || defined(SUPPORT_OutputProtocol_Renard)