InputE131.hpp

Go to the documentation of this file.

#pragma once
/*
* E131Input.h - Code to wrap ESPAsyncE131 for input
*
* Project: ESPixelStick - An ESP8266 / ESP32 and E1.31 based pixel driver
* Copyright (c) 2021, 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.
*
*/
 
#include "InputCommon.hpp"
#include <ESPAsyncE131.h>
 
class c_InputE131 : public c_InputCommon
{
  private:
    static const uint16_t   UNIVERSE_MAX = 512;
    static const char       ConfigFileName[];
    static const uint8_t    MAX_NUM_UNIVERSES = (OM_MAX_NUM_CHANNELS / UNIVERSE_MAX) + 1;
 
    ESPAsyncE131  * e131 = nullptr; 
    // e131_packet_t packet;           ///< Packet buffer for parsing
 
    uint16_t    startUniverse              = 1;    
    uint16_t    LastUniverse               = 1;    
    uint16_t    ChannelsPerUniverse        = 512;  
    uint16_t    FirstUniverseChannelOffset = 1;    
    ESPAsyncE131PortId PortId              = E131_DEFAULT_PORT;
    bool        ESPAsyncE131Initialized    = false;
 
    uint16_t    channel_count = 0;       
 
    struct Universe_t
    {
      uint32_t   DestinationOffset;
      uint32_t   BytesToCopy;
      uint32_t   SourceDataOffset;
      uint8_t    SequenceNumber;
      uint32_t   SequenceErrorCounter;
    };
    Universe_t UniverseArray[MAX_NUM_UNIVERSES];
 
    void validateConfiguration ();
    void NetworkStateChanged (bool IsConnected, bool RebootAllowed); // used by poorly designed rx functions
    void SetBufferTranslation ();
 
  public:
 
    c_InputE131 (c_InputMgr::e_InputChannelIds NewInputChannelId,
                 c_InputMgr::e_InputType       NewChannelType,
                 uint32_t                        BufferSize);
    virtual ~c_InputE131();
 
    // functions to be provided by the derived class
    void Begin ();                                          
    bool SetConfig (JsonObject & jsonConfig);   
    void GetConfig (JsonObject & jsonConfig);   
    void GetStatus (JsonObject & jsonStatus);
    void Process   ();
    void GetDriverName (String & sDriverName) { sDriverName = "E1.31"; } 
    void SetBufferInfo (uint32_t BufferSize);
    void NetworkStateChanged (bool IsConnected); // used by poorly designed rx functions
    bool isShutDownRebootNeeded () { return HasBeenInitialized; }
    void ProcessIncomingE131Data (e131_packet_t *);
};