OutputWS2811Rmt.hpp

Go to the documentation of this file.

#pragma once
/*
* OutputWS2811Rmt.h - WS2811 driver code for ESPixelStick RMT Channel
*
* Project: ESPixelStick - An ESP8266 / ESP32 and E1.31 based pixel driver
* Copyright (c) 2015, 2025 Shelby Merrick
* http://www.forkineye.com
*
*  This program is provided free for you to use in any way that you wish,
*  subject to the laws and regulations where you are using it.  Due diligence
*  is strongly suggested before using this code.  Please give credit where due.
*
*  The Author makes no warranty of any kind, express or implied, with regard
*  to this program or the documentation contained in this document.  The
*  Author shall not be liable in any event for incidental or consequential
*  damages in connection with, or arising out of, the furnishing, performance
*  or use of these programs.
*
*   This is a derived class that converts data in the output buffer into
*   pixel intensities and then transmits them through the configured serial
*   interface.
*
*/
#include "ESPixelStick.h"
#if defined(SUPPORT_OutputProtocol_WS2811) && defined(ARDUINO_ARCH_ESP32)
 
#include "OutputWS2811.hpp"
#include "OutputRmt.hpp"
 
class c_OutputWS2811Rmt : public c_OutputWS2811
{
public:
    // These functions are inherited from c_OutputCommon
    c_OutputWS2811Rmt (OM_OutputPortDefinition_t & OutputPortDefinition,
                       c_OutputMgr::e_OutputProtocolType outputType);
    virtual ~c_OutputWS2811Rmt ();
 
    // functions to be provided by the derived class
    void    Begin ();                                         
    bool    SetConfig (ArduinoJson::JsonObject& jsonConfig);  
    uint32_t Poll ();                                        
    bool    RmtPoll ();
    void    GetStatus (ArduinoJson::JsonObject& jsonStatus);
    void    SetOutputBufferSize (uint32_t NumChannelsAvailable);
    void    PauseOutput(bool State);
    bool    ISR_GetNextBitToSend (rmt_item32_t &DataToSend);
    void    StartNewDataFrame();
 
private:
 
#ifdef USE_RMT_DEBUG_COUNTERS
    uint32_t CanRefresh = 0;
    uint32_t CannotRefresh = 0;
#endif // def USE_RMT_DEBUG_COUNTERS
// The adjustments compensate for rounding errors in the calculations
#define WS2811_PIXEL_RMT_TICKS_BIT_0_HIGH    uint16_t ( (WS2811_PIXEL_NS_BIT_0_HIGH / RMT_TickLengthNS) + 0.0)
#define WS2811_PIXEL_RMT_TICKS_BIT_0_LOW     uint16_t ( (WS2811_PIXEL_NS_BIT_0_LOW  / RMT_TickLengthNS) + 0.0)
#define WS2811_PIXEL_RMT_TICKS_BIT_1_HIGH    uint16_t ( (WS2811_PIXEL_NS_BIT_1_HIGH / RMT_TickLengthNS) - 1.0)
#define WS2811_PIXEL_RMT_TICKS_BIT_1_LOW     uint16_t ( (WS2811_PIXEL_NS_BIT_1_LOW  / RMT_TickLengthNS) + 1.0)
#define WS2811_PIXEL_RMT_TICKS_IDLE          uint16_t ( (WS2811_PIXEL_IDLE_TIME_NS  / RMT_TickLengthNS) + 1.0)
 
    rmt_item32_t    ZeroBit;
    rmt_item32_t    OneBit;
    rmt_item32_t    IfgBit;
    uint32_t        IfgBitCount;
    uint32_t        IfgBitCurrentCount;
    uint32_t        DataPattern;
    uint32_t        DataPatternMask;
 
    // #define WS2811_RMT_DEBUG_COUNTERS
    #ifdef WS2811_RMT_DEBUG_COUNTERS
    #define INC_WS2811_RMT_DEBUG_COUNTERS(c) (++RmtDebugCounters.c)
    struct
    {
        uint32_t GetNextBit = 0;
        uint32_t FrameStarts = 0;
        uint32_t FrameEnds = 0;
        uint32_t StartBits = 0;
        uint32_t IfgBits = 0;
        uint32_t DataBits = 0;
        uint32_t DataBytes = 0;
        uint32_t StopBits = 0;
        uint32_t Underrun = 0;
    } RmtDebugCounters;
    #else
    #define INC_WS2811_RMT_DEBUG_COUNTERS(c)
    #endif // def WS2811_RMT_DEBUG_COUNTERS
 
    c_OutputRmt Rmt;
 
}; // c_OutputWS2811Rmt
 
#endif // defined(SUPPORT_OutputProtocol_WS2811) && defined(ARDUINO_ARCH_ESP32)