ENTS-tock
Environmental NeTworked Sensor firmware on Tock OS
Loading...
Searching...
No Matches
template_module.hpp
Go to the documentation of this file.
1
12#ifndef LIB_MODULE_HANDLER_INCLUDE_TEMPLATE_MODULE_HPP_
13#define LIB_MODULE_HANDLER_INCLUDE_TEMPLATE_MODULE_HPP_
14
15#include <libents/proto/controller.pb.h>
16
17#include <cstddef>
18
19namespace ModuleHandler {
20
29class Module {
30 public:
35 Module(void);
36
41 ~Module(void);
42
48 virtual void OnReceive(const Esp32Command& cmd) = 0;
49
57 virtual size_t OnRequest(uint8_t* buffer) = 0;
58
64 int State(void);
65
74 int Type();
75
81 void Reset(void);
82
83 protected:
85 int state = 0;
86
88 int type = 0;
89};
90} // namespace ModuleHandler
91
96#endif // LIB_MODULE_HANDLER_INCLUDE_TEMPLATE_MODULE_HPP_
ModuleHandler::Module
Class prototype for modules.
Definition template_module.hpp:29
ModuleHandler::Module::Type
int Type()
Get the message type associated with the module.
Definition template_module.cpp:11
ModuleHandler::Module::~Module
~Module(void)
Destroy the Module object.
Definition template_module.cpp:5
ModuleHandler::Module::Reset
void Reset(void)
Resets the module to default state.
Definition template_module.cpp:7
ModuleHandler::Module::Module
Module(void)
Construct a new Module object.
Definition template_module.cpp:3
ModuleHandler::Module::State
int State(void)
Get the current state of the module.
Definition template_module.cpp:9
ModuleHandler::Module::OnReceive
virtual void OnReceive(const Esp32Command &cmd)=0
Arduino I2C onRecieve.
ModuleHandler::Module::OnRequest
virtual size_t OnRequest(uint8_t *buffer)=0
Arduino I2C onRequest.
buffer
uint8_t buffer[32]
Definition example_i2c.cpp:14
ModuleHandler
Power module for the esp32.
Definition module_handler.hpp:36