Relay Class Reference

#include <Relay.h>

Inheritance diagram for Relay:

Public Member Functions
short	debug ()
	Virtual function to debug the component.
short	info (short val0, short val1)
	Virtual function to display information about the component.
short	loop ()
	Virtual function to run the component in a loop.
short	onRegisterMethods (Bridge *bridge)
	Relay (Component *owner, short _pin, short _id, short _addr, short _val=0)
short	set (int val)
short	setup ()
	Virtual function to set up the component.
Public Member Functions inherited from Component
void	clearFlag (byte flag)
	Clears a specific flag for the component.
	Component ()
	Default constructor for the Component class.
	Component (String _name)
	Constructor for the Component class with a specified name.
	Component (String _name, short _id)
	Constructor for the Component class with a specified name and ID.
	Component (String _name, short _id, int _flags)
	Constructor for the Component class with a specified name, ID, and flags.
	Component (String _name, short _id, int _flags, Component *_owner)
	Constructor for the Component class with a specified name, ID, flags, and owner.
virtual short	debug (short val0, short val1)
	Virtual function to debug the component.
virtual short	destroy ()
	Virtual function to destroy the component.
void	disable ()
	Disables the component.
void	enable ()
	Enables the component.
bool	enabled ()
	Checks if the component is enabled.
bool	hasFlag (byte flag)
	Checks if the component has a specific flag.
virtual short	info ()
	Virtual function to display information about the component.
virtual short	onError (short id, short error)
virtual short	onMessage (int id, E_CALLS verb, E_MessageFlags flags, const void *user, Component *src)
	Handles incoming messages.
virtual short	onRawResponse (short size, uint8_t rxBuffer[])
virtual short	onResponse (short error)
void	setFlag (byte flag)
	Sets a specific flag for the component.
	~Component ()
	Destructor for the Component class.
Public Member Functions inherited from ModbusGateway
short	getAddress ()
MB_FC	getFunctionCode ()
short	getNumberAddresses ()
virtual String	getRegisterDescription (short flags=0)
const char *	getRegisterMode ()
	ModbusGateway ()
	ModbusGateway (short _addr)
	ModbusGateway (short _addr, short _fc)
void	setAddress (short _addr)
void	setFunctionCode (MB_FC fc)
void	setGateway (Mudbus *mudbus)
void	setNumberAddresses (short _nbAddr)
void	setRegisterMode (MB_REGISTER_MODE mode)
Public Member Functions inherited from ModbusValue< bool >
	ModbusValue (int _addr)
	ModbusValue (int _addr, int _fc)
bool	netVal ()
void	onChange (const bool &value)
void	onSet (const bool &value)

Public Attributes
short	pin
bool	value
Public Attributes inherited from Component
int	flags
	The run flags for the component.
const short	id
	The ID of the component.
millis_t	last
	The last tick time in milliseconds.
String	name
	The name of the component.
int	nFlags
	The network capabilities of the component.
millis_t	now
	The current time in milliseconds.
Component *	owner
	The owner of the component.
Public Attributes inherited from ModbusGateway
short	addr
MB_FC	fn
uchar	lastMQSlot
Mudbus *	mudbus
short	nbAddr
short	registerMode

Additional Inherited Members
Static Public Attributes inherited from Component
static const int	COMPONENT_DEFAULT = 1 << OBJECT_RUN_FLAGS::E_OF_LOOP | 1 << OBJECT_RUN_FLAGS::E_OF_SETUP
	The default run flags for a component.
static const int	COMPONENT_NO_ID = 0
	The default ID for a component.

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 ( )

inlinevirtual

Virtual function to debug the component.

Parameters

stream

The stream to output the debug information to.

Returns

The error code indicating the success or failure of the operation.

Reimplemented from Component.

Definition at line 42 of file Relay.h.

    {
        return info(0,0);
    }

info()

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

inlinevirtual

Virtual function to display information about the component.

Parameters

stream

The stream to output the information to.

Returns

The error code indicating the success or failure of the operation.

Reimplemented from Component.

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 ( )

inlinevirtual

Virtual function to run the component in a loop.

Returns

The error code indicating the success or failure of the operation.

Reimplemented from Component.

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 )

inlinevirtual

Registers methods for the component with the specified bridge. This method should be overridden by derived classes to provide custom method registration logic.

Parameters

bridge

The bridge to register methods with.

Returns

The status code indicating the success or failure of the method registration.

Reimplemented from Component.

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 ( )

inlinevirtual

Virtual function to set up the component.

Returns

The error code indicating the success or failure of the operation.

Reimplemented from Component.

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