ModuleTest Class Reference

#include </home/runner/work/ENTS-tock/ENTS-tock/embedded/esp32/test/module_handler/test_modules/module_test.hpp>

Inheritance diagram for ModuleTest:

Public Types
enum	StateEnum { INIT = 0 , RECEIVE = 1 , RECEIVE_REQUEST = 2 , REQUEST = 3 }

Public Member Functions
	ModuleTest (void)
	Construct a new Module Test object.
	~ModuleTest (void)
	Destroy the Module Test object.
void	OnReceive (const Esp32Command &cmd)
	Handles i2c receive messages.
size_t	OnRequest (uint8_t *buffer)
	Handles i2c request messages.
Public Member Functions inherited from ModuleHandler::Module
	Module (void)
	Construct a new Module object.
	~Module (void)
	Destroy the Module object.
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.

Additional Inherited Members
Protected Attributes inherited from ModuleHandler::Module
int	state = 0
int	type = 0

Detailed Description

Definition at line 7 of file module_test.hpp.

Member Enumeration Documentation

StateEnum

enum ModuleTest::StateEnum

Possible internal states

Enumerator
INIT
RECEIVE
RECEIVE_REQUEST
REQUEST

Definition at line 22 of file module_test.hpp.

Constructor & Destructor Documentation

ModuleTest()

ModuleTest::ModuleTest

(

void

)

Construct a new Module Test object.

Definition at line 3 of file module_test.cpp.

~ModuleTest()

ModuleTest::~ModuleTest

(

void

)

Destroy the Module Test object.

Definition at line 5 of file module_test.cpp.

Member Function Documentation

OnReceive()

void ModuleTest::OnReceive ( const Esp32Command &  cmd )

virtual

Handles i2c receive messages.

If cmd state is RECEIVE then change internal state

If cmd state is REQUEST store inter in data as byte array

Parameters

cmd

Implements ModuleHandler::Module.

Definition at line 7 of file module_test.cpp.

References RECEIVE, REQUEST, and ModuleHandler::Module::state.

OnRequest()

size_t ModuleTest::OnRequest ( uint8_t *  buffer )

virtual

Handles i2c request messages.

Replies with data from receive message

Parameters

buffer

Reference to tx buffer

Returns

Number of bytes written to buffer

Implements ModuleHandler::Module.

Definition at line 22 of file module_test.cpp.

References buffer, INIT, and ModuleHandler::Module::state.

---

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

• embedded/esp32/test/module_handler/test_modules/module_test.hpp
• embedded/esp32/test/module_handler/test_modules/module_test.cpp