Relay Class Reference

#include <Relay.h>

Inheritance diagram for Relay:

Public Member Functions
short	debug ()
short	info (short val0, short val1)
short	loop ()
short	onRegisterMethods (Bridge *bridge)
	Relay (Component *owner, short _pin, short _id, short _addr, short _val=0)
short	set (int val)
short	setup ()

Public Attributes
short	pin
bool	value

Detailed Description

Definition at line 17 of file Relay.h.

Constructor & Destructor Documentation

Relay()

Relay::Relay ( Component *  owner, short  _pin, short  _id, short  _addr, short  _val = 0  )

inline

Definition at line 21 of file Relay.h.

                        : ModbusValue<bool>(_addr, MB_FC::MB_FC_READ_COILS),
                       Component("MB_Relay", _id, Component::COMPONENT_DEFAULT, owner),
                       pin(_pin),
                       value(_val)
                       //registerMode(MB_REGISTER_MODE::E_MB_REGISTER_MODE_READ_WRITE)
    {
        //setFlag(OBJECT_RUN_FLAGS::E_OF_DEBUG);
        SBI(nFlags, OBJECT_NET_CAPS::E_NCAPS_MODBUS);
        setRegisterMode(MB_REGISTER_MODE::E_MB_REGISTER_MODE_READ_WRITE);
    }

Member Function Documentation

debug()

short Relay::debug ( )

inline

Definition at line 42 of file Relay.h.

    {
        return info(0,0);
    }

info()

short Relay::info ( short  val0, short  val1  )

inline

Definition at line 37 of file Relay.h.

    {
        Log.verboseln("Relay::info - Pin=%d | Key=%d | Addr=%d | Val=%d | NetVal=%d ", pin, id, addr, value, netVal());
        return E_OK;
    }

loop()

short Relay::loop ( )

inline

Definition at line 96 of file Relay.h.

    {
        bool val = netVal();
        if (val != value)
        {
            set(val);
        }
        return E_OK;
    }

onRegisterMethods()

short Relay::onRegisterMethods ( Bridge *  bridge )

inline

Definition at line 87 of file Relay.h.

    {
        bridge->registerMemberFunction(id, this, C_STR("set"), (ComponentFnPtr)&Relay::set);
        bridge->registerMemberFunction(id, this, C_STR("info"), (ComponentFnPtr)&Relay::info);
        bridge->registerMemberFunction(id, this, C_STR("setFlag"), (ComponentFnPtr)&Relay::setFlag);
        //bridge->registerMemberFunction(id, this, C_STR("clearFlag"), (ComponentFnPtr)&Relay::clearFlag);
        return E_OK;
    }

set()

short Relay::set ( int  val )

inline

Definition at line 61 of file Relay.h.

    {
        value = val;
#ifdef PLATFORM_PORTENTA_H7_M7
        if (_value == 1)
        {
            digital_outputs.set(pin, HIGH);
            Log.verbose(F("Relay:set pin=%d value=%d" CR), pin, _value);
        }
        else
        {
            digital_outputs.set(pin, LOW);
            Log.verbose(F("Relay:set pin=%d value=%d" CR), pin, _value);
        }
#endif
 
#ifdef PLATFORM_CONTROLLINO_MEGA
        digitalWrite(pin, val ? HIGH : LOW);
#endif        
        if (netVal() != value)
        {
            onSet(val);
        }
        return val;
    }

setup()

short Relay::setup ( )

inline

Definition at line 47 of file Relay.h.

    {
#ifdef PLATFORM_PORTENTA_H7_M7
        /*
        digital_outputs.setLatch();
        // Uncomment this line to set over current behavior of all
        // channels to auto retry mode instead of latch mode:
        // digital_outputs.setRetry();
        digital_outputs.set(pin, LOW);
        */
#endif
        return E_OK;
    }

Member Data Documentation

pin

short Relay::pin

Definition at line 106 of file Relay.h.

value

bool Relay::value

Definition at line 107 of file Relay.h.

---

The documentation for this class was generated from the following file:

• Relay.h