Class prototype for modules. More...

#include <module_handler/include/template_module.hpp>

Inheritance diagram for ModuleHandler::Module:

Public Member Functions
	Module (void)
	Construct a new Module object.

	~Module (void)
	Destroy the Module object.

virtual void	OnReceive (const Esp32Command &cmd)=0
	Arduino I2C onRecieve.

virtual size_t	OnRequest (uint8_t *buffer)=0
	Arduino I2C onRequest.

int	State (void)
	Get the current state of the module.

int	Type ()
	Get the message type associated with the module.

void	Reset (void)
	Resets the module to default state.

Protected Attributes
int	state = 0

int	type = 0

Detailed Description

Class prototype for modules.

Provides a base class for modules to inherit from.

Definition at line 29 of file template_module.hpp.

Constructor & Destructor Documentation

◆ Module()

ModuleHandler::Module::Module ( void )

Construct a new Module object.

Definition at line 3 of file template_module.cpp.

◆ ~Module()

ModuleHandler::Module::~Module ( void )

Destroy the Module object.

Definition at line 5 of file template_module.cpp.

Member Function Documentation

◆ OnReceive()

virtual void ModuleHandler::Module::OnReceive ( const Esp32Command & cmd )

pure virtual

Arduino I2C onRecieve.

Parameters

num_bytes Number of bytes received from controller

Implemented in ModuleIrrigation, ModuleMicroSD, ModuleHandler::ModulePower, ModuleWiFi, ModuleTest, and ModuleHandler::ModuleUserConfig.

◆ OnRequest()

virtual size_t ModuleHandler::Module::OnRequest ( uint8_t * buffer )

pure virtual

Arduino I2C onRequest.

Parameters

buffer Pointer to store requested data

Returns: Number of bytes in buffer

Implemented in ModuleIrrigation, ModuleMicroSD, ModuleHandler::ModulePower, ModuleWiFi, ModuleTest, and ModuleHandler::ModuleUserConfig.

◆ Reset()

void ModuleHandler::Module::Reset ( void )

Resets the module to default state.

The default state is

Definition at line 7 of file template_module.cpp.

References state.

Referenced by ModuleHandler::ModuleHandler::ResetModules(), and setUp().

◆ State()

int ModuleHandler::Module::State ( void )

Get the current state of the module.

Returns: Integer of state enum

Definition at line 9 of file template_module.cpp.

References state.

Referenced by test_Connect(), TestOnReceive(), TestOnRequest(), and TestReset().

◆ Type()

int ModuleHandler::Module::Type ( )

Get the message type associated with the module.

Full list of message types are available in generated protobuf code under *_tag.

Returns: Integer fo type

Definition at line 11 of file template_module.cpp.

Field Documentation

◆ state

int ModuleHandler::Module::state = 0

protected

Integer representing current state

Definition at line 85 of file template_module.hpp.

Referenced by ModuleHandler::ModuleUserConfig::ModuleUserConfig(), ModuleTest::OnReceive(), and ModuleTest::OnRequest().

◆ type

int ModuleHandler::Module::type = 0