Relay #include <Relay.h> Inheritance diagram for Relay: 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) 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 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.

Definition at line 17 of file Relay.h.

RelayRelay RelayRelay Relay::Relay (Component * owner, short _pin, short _id, short _addr, short _val = 0 )[inline] Definition at line 21 of file Relay.h. 00026 : ModbusValue<bool>(_addr, MB_FC::MB_FC_READ_COILS), 00027 Component("MB_Relay", _id, Component::COMPONENT_DEFAULT, owner), 00028 pin(_pin), 00029 value(_val) 00030 //registerMode(MB_REGISTER_MODE::E_MB_REGISTER_MODE_READ_WRITE) 00031 { 00032 //setFlag(OBJECT_RUN_FLAGS::E_OF_DEBUG); 00033 SBI(nFlags, OBJECT_NET_CAPS::E_NCAPS_MODBUS); 00034 setRegisterMode(MB_REGISTER_MODE::E_MB_REGISTER_MODE_READ_WRITE); 00035 }

debugRelay Relaydebug short Relay::debug ( )[inline], [virtual] Virtual function to debug the component. stream The stream to output the debug information to. The error code indicating the success or failure of the operation. Reimplemented from Component. Definition at line 42 of file Relay.h. 00043 { 00044 return info(0,0); 00045 }

infoRelay Relayinfo short Relay::info (short val0, short val1)[inline], [virtual] Virtual function to display information about the component. stream The stream to output the information to. The error code indicating the success or failure of the operation. Reimplemented from Component. Definition at line 37 of file Relay.h. 00038 { 00039 Log.verboseln("Relay::info - Pin=%d | Key=%d | Addr=%d | Val=%d | NetVal=%d ", pin, id, addr, value, netVal()); 00040 return E_OK; 00041 }

loopRelay Relayloop short Relay::loop ( )[inline], [virtual] Virtual function to run the component in a loop. The error code indicating the success or failure of the operation. Reimplemented from Component. Definition at line 96 of file Relay.h. 00097 { 00098 bool val = netVal(); 00099 if (val != value) 00100 { 00101 set(val); 00102 } 00103 return E_OK; 00104 }

onRegisterMethodsRelay RelayonRegisterMethods short Relay::onRegisterMethods (Bridge * bridge)[inline], [virtual] Registers methods for the component with the specified bridge. This method should be overridden by derived classes to provide custom method registration logic. bridge The bridge to register methods with. The status code indicating the success or failure of the method registration. Reimplemented from Component. Definition at line 87 of file Relay.h. 00088 { 00089 bridge->registerMemberFunction(id, this, C_STR("set"), (ComponentFnPtr)&Relay::set); 00090 bridge->registerMemberFunction(id, this, C_STR("info"), (ComponentFnPtr)&Relay::info); 00091 bridge->registerMemberFunction(id, this, C_STR("setFlag"), (ComponentFnPtr)&Relay::setFlag); 00092 //bridge->registerMemberFunction(id, this, C_STR("clearFlag"), (ComponentFnPtr)&Relay::clearFlag); 00093 return E_OK; 00094 }

setRelay Relayset short Relay::set (int val)[inline] Definition at line 61 of file Relay.h. 00062 { 00063 value = val; 00064 #ifdef PLATFORM_PORTENTA_H7_M7␍ 00065 if (_value == 1) 00066 { 00067 digital_outputs.set(pin, HIGH); 00068 Log.verbose(F("Relay:set pin=%d value=%d" CR), pin, _value); 00069 } 00070 else 00071 { 00072 digital_outputs.set(pin, LOW); 00073 Log.verbose(F("Relay:set pin=%d value=%d" CR), pin, _value); 00074 } 00075 #endif␍ 00076 00077 #ifdef PLATFORM_CONTROLLINO_MEGA␍ 00078 digitalWrite(pin, val ? HIGH : LOW); 00079 #endif ␍ 00080 if (netVal() != value) 00081 { 00082 onSet(val); 00083 } 00084 return val; 00085 }

setupRelay Relaysetup short Relay::setup ( )[inline], [virtual] Virtual function to set up the component. The error code indicating the success or failure of the operation. Reimplemented from Component. Definition at line 47 of file Relay.h. 00048 { 00049 #ifdef PLATFORM_PORTENTA_H7_M7␍ 00050 /* 00051 digital_outputs.setLatch();␍ 00052 // Uncomment this line to set over current behavior of all␍ 00053 // channels to auto retry mode instead of latch mode:␍ 00054 // digital_outputs.setRetry();␍ 00055 digital_outputs.set(pin, LOW);␍ 00056 */ 00057 #endif␍ 00058 return E_OK; 00059 }

pinRelay Relaypin short Relay::pin Definition at line 106 of file Relay.h.

valueRelay Relayvalue bool Relay::value Definition at line 107 of file Relay.h.

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