OutputRelay.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 copyright 2015 - 2026 Shelby Merrick
*
*       Brought to you by:
*              Bill Porter
*              www.billporter.info
*
*       See Readme for other info and version history
*
*
*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
*   Relay States and then outputs on a GPIO
*
*/
#include "ESPixelStick.h"
 
#ifdef SUPPORT_OutputProtocol_Relay
 
#include "OutputCommon.hpp"
 
class c_OutputRelay : public c_OutputCommon
{
public:
    struct RelayChannel_t
    {
        // bool        Enabled;
        bool        httpEnabled;
        bool        InvertOutput;
        bool        Pwm;
        uint8_t     OnOffTriggerLevel;
        gpio_num_t  GpioId;
        uint8_t     OnValue;
        uint8_t     OffValue;
        uint8_t     previousValue;
#if defined(ARDUINO_ARCH_ESP32)
        uint16_t    PwmFrequency;
#endif // defined(ARDUINO_ARCH_ESP32)
        uint8_t     ChannelIndex;
    };
 
    // These functions are inherited from c_OutputCommon
    c_OutputRelay (OM_OutputPortDefinition_t & OutputPortDefinition,
                   c_OutputMgr::e_OutputProtocolType outputType);
    virtual ~c_OutputRelay ();
 
    // functions to be provided by the derived class
    void        Begin ();                                         
    bool        SetConfig (ArduinoJson::JsonObject & jsonConfig); 
    void        GetConfig (ArduinoJson::JsonObject & jsonConfig); 
    uint32_t    Poll ();                                        
#if defined(ARDUINO_ARCH_ESP32)
    bool        RmtPoll () {return false;}
#endif // defined(ARDUINO_ARCH_ESP32)
    void        GetDriverName (String& sDriverName);
    void        GetStatus (ArduinoJson::JsonObject & jsonStatus);
    uint32_t    GetNumOutputBufferBytesNeeded () { return Num_Channels; }
    uint32_t    GetNumOutputBufferChannelsServiced () { return Num_Channels; }
    bool        ValidateGpio (gpio_num_t ConsoleTxGpio, gpio_num_t ConsoleRxGpio);
    void        RelayUpdate  (uint8_t RelayId, String & NewValue, String & Response);
 
private:
// #   define OM_RELAY_CHANNEL_LIMIT           8
#   define OM_RELAY_CHANNEL_LIMIT           1
#   define OM_RELAY_UPDATE_INTERVAL_NAME    CN_updateinterval
// #   define OM_RELAY_CHANNEL_ENABLED_NAME    CN_en
#   define OM_RELAY_CHANNEL_INVERT_NAME     CN_inv
#   define OM_RELAY_CHANNEL_PWM_NAME        CN_pwm
 
    bool    validate ();
    void    OutputValue(RelayChannel_t & currentRelay, uint8_t NewValue);
 
    // config data
    RelayChannel_t  OutputList[OM_RELAY_CHANNEL_LIMIT];
    uint16_t        UpdateInterval = 0;
 
    // non config data
    uint16_t    Num_Channels = OM_RELAY_CHANNEL_LIMIT;
 
}; // c_OutputRelay
 
#endif // def SUPPORT_OutputProtocol_Relay