App The App class represents the main application component. #include <App.h> Inheritance diagram for App: App () Default constructor for the App class. Component * byId (short id) Retrieves a component by its ID. virtual short debug () Performs debugging operations for the application. virtual short info () Retrieves information about the application. virtual short loop () Runs the main loop of the application. virtual short numByFlag (ushort flag) Retrieves the number of components with a specific flag. virtual void printRegisters () virtual short registerComponents (Bridge *bridge) Register all components in Bridge virtual short setup () Performs the setup operations for the application and it's components. 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 (short val0, short val1) 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 onRegisterMethods (Bridge *bridge) 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) Bridge * bridge Vector< Component * > components The list of components in the application. millis_t DEBUG_INTERVAL The interval for debugging operations. millis_t debugTS The timestamp for the last debug operation. millis_t loopTS The timestamp for the last loop operation. Vector< ModbusGateway * > nComponents The list of components in the application. Timer< 10, millis > timer The timer used for scheduling tasks. millis_t wait The wait time between loop iterations. millis_t waitTS The timestamp for the last wait operation. 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.

The App class represents the main application component. This class inherits from the Component class and provides functionality for setting up, running the main loop, debugging, and providing information about the application. Definition at line 17 of file App.h.

AppApp AppApp App::App ( ) Default constructor for the App class. Definition at line 14 of file App.cpp. 00014 : Component("APP", 0, Component::COMPONENT_DEFAULT) 00015 { 00016 DEBUG_INTERVAL = 1000; 00017 components.setStorage(componentsArray); 00018 nComponents.setStorage(componentsArrayModbus); 00019 debugTS = 0; 00020 }

byIdApp AppbyId Component * App::byId (short id) Retrieves a component by its ID. id The ID of the component to retrieve. A pointer to the component with the specified ID, or nullptr if not found. Definition at line 140 of file App.cpp. 00141 { 00142 uchar s = components.size(); 00143 for (uchar i = 0; i < s; i++) 00144 { 00145 Component *component = components[i]; 00146 if (component->id == id) 00147 { 00148 return component; 00149 } 00150 } 00151 return NULL; 00152 }

debugApp Appdebug short App::debug ( )[virtual] Performs debugging operations for the application. A status code indicating the result of the debug operation. Reimplemented from Component. Definition at line 99 of file App.cpp. 00100 { 00101 if (millis() - debugTS > DEBUG_INTERVAL) 00102 { 00103 uchar s = components.size(); 00104 uchar nb = 0; 00105 for (uchar i = 0; i < s; i++) 00106 { 00107 Component *component = components[i]; 00108 if (component->hasFlag(OBJECT_RUN_FLAGS::E_OF_DEBUG)) 00109 { 00110 if (component->debug()) 00111 { 00112 Serial.println("\n"); 00113 nb++; 00114 } 00115 } 00116 } 00117 if (nb) 00118 { 00119 Serial.println("\n"); 00120 } 00121 debugTS = millis(); 00122 } 00123 return E_OK; 00124 }

infoApp Appinfo short App::info ( )[virtual] Retrieves information about the application. A status code indicating the result of the info operation. Reimplemented from Component. Definition at line 126 of file App.cpp. 00127 { 00128 uchar s = components.size(); 00129 for (uchar i = 0; i < s; i++) 00130 { 00131 Component *component = components[i]; 00132 if (component->hasFlag(OBJECT_RUN_FLAGS::E_OF_INFO)) 00133 { 00134 component->info(); 00135 } 00136 } 00137 return E_OK; 00138 }

loopApp Apploop short App::loop ( )[virtual] Runs the main loop of the application. A status code indicating the result of the loop operation. Reimplemented from Component. Reimplemented in PHApp. Definition at line 63 of file App.cpp. 00064 { 00065 timer.tick(); 00066 now = millis(); 00067 uchar s = components.size(); 00068 for (uchar i = 0; i < s; i++) 00069 { 00070 Component *component = components[i]; 00071 if (component->hasFlag(OBJECT_RUN_FLAGS::E_OF_LOOP)) 00072 { 00073 component->now = now; 00074 component->loop(); 00075 } 00076 } 00077 debug(); 00078 return E_OK; 00079 }

numByFlagApp AppnumByFlag short App::numByFlag (ushort flag)[virtual] Retrieves the number of components with a specific flag. flag The flag to filter the components by. The number of components with the specified flag. Definition at line 84 of file App.cpp. 00085 { 00086 uchar s = components.size(); 00087 uchar l = 0; 00088 for (uchar i = 0; i < s; i++) 00089 { 00090 Component *component = components[i]; 00091 if (!!(component->hasFlag(flag))) 00092 { 00093 l++; 00094 } 00095 } 00096 return l; 00097 }

printRegistersApp AppprintRegisters virtual void App::printRegisters ( )[inline], [virtual] Reimplemented in PHApp. Definition at line 123 of file App.h. 00123 { return E_OK; }

registerComponentsApp AppregisterComponents short App::registerComponents (Bridge * bridge)[virtual] Register all components in Bridge A status code indicating the result of the setup operation. Definition at line 48 of file App.cpp. 00049 { 00050 uchar s = components.size(); 00051 for (uchar i = 0; i < s; i++) 00052 { 00053 Component *component = components[i]; 00054 if (component->hasFlag(OBJECT_RUN_FLAGS::E_OF_DISABLED)) 00055 { 00056 continue; 00057 } 00058 component->onRegisterMethods(bridge); 00059 } 00060 return E_OK; 00061 }

setupApp Appsetup short App::setup ( )[virtual] Performs the setup operations for the application and it's components. A status code indicating the result of the setup operation. Reimplemented from Component. Reimplemented in PHApp. Definition at line 22 of file App.cpp. 00023 { 00024 Log.verbose(F("* App:setup *" CR)); 00025 uchar s = components.size(); 00026 for (uchar i = 0; i < s; i++) 00027 { 00028 Component *component = components[i]; 00029 if (!component->owner) 00030 { 00031 component->owner = this; 00032 } 00033 if (component->hasFlag(OBJECT_RUN_FLAGS::E_OF_SETUP)) 00034 { 00035 component->setup(); 00036 } 00037 } 00038 00039 info(); 00040 /* 00041 if (bridge) 00042 { 00043 bridge->onRegisterMethods(bridge); 00044 }*/ 00045 return E_OK; 00046 }

bridgeApp Appbridge Bridge* App::bridge Definition at line 121 of file App.h.

componentsApp Appcomponents Vector<Component *> App::components The list of components in the application. Definition at line 73 of file App.h.

DEBUG_INTERVALApp AppDEBUG_INTERVAL millis_t App::DEBUG_INTERVAL The interval for debugging operations. Definition at line 108 of file App.h.

debugTSApp AppdebugTS millis_t App::debugTS The timestamp for the last debug operation. Definition at line 83 of file App.h.

loopTSApp ApploopTS millis_t App::loopTS The timestamp for the last loop operation. Definition at line 88 of file App.h.

nComponentsApp AppnComponents Vector<ModbusGateway *> App::nComponents The list of components in the application. Definition at line 78 of file App.h.

timerApp Apptimer Timer<10, millis> App::timer The timer used for scheduling tasks. Definition at line 103 of file App.h.

waitApp Appwait millis_t App::wait The wait time between loop iterations. Definition at line 93 of file App.h.

waitTSApp AppwaitTS millis_t App::waitTS The timestamp for the last wait operation. Definition at line 98 of file App.h.

The documentation for this class was generated from the following files: App.hApp.cpp