Base Component

The espp::BaseComponent provides a simple base class for all components in the ESP-CPP package. It provides a simple interface for the component to be initialized and to be updated.

It is not required to use the BaseComponent class, but it is recommended to use as it provides a standardized API for logging and log management.

API Reference

Header File

Classes

class BaseComponent

Base class for all components Provides a logger and some basic logging configuration

Subclassed by espp::BasePeripheral< uint8_t, bmi270::Interface::I2C==bmi270::Interface::I2C >, espp::BasePeripheral< std::uint8_t >, espp::BasePeripheral< std::uint16_t >, espp::BasePeripheral< uint8_t, icm20948::Interface::I2C==icm20948::Interface::I2C >, espp::BasePeripheral< uint8_t, icm42607::Interface::I2C==icm42607::Interface::I2C >, espp::BasePeripheral< uint8_t, true >, espp::BasePeripheral< uint8_t, lsm6dso::Interface::I2C==lsm6dso::Interface::I2C >, espp::BasePeripheral< uint8_t, Mt6701Interface::I2C==Mt6701Interface::I2C >, espp::BasePeripheral< uint8_t, qmi8658::Interface::I2C==qmi8658::Interface::I2C >, espp::BasePeripheral< uint16_t >, espp::BasePeripheral< vl53l_register_t, true >, espp::BasePeripheral< std::uint8_t, true >, espp::BasePeripheral< uint8_t, Interface==bmi270::Interface::I2C >, espp::BasePeripheral< uint8_t, Interface==icm20948::Interface::I2C >, espp::BasePeripheral< uint8_t, Interface==icm42607::Interface::I2C >, espp::BasePeripheral< uint8_t, Interface==lsm6dso::Interface::I2C >, espp::BasePeripheral< uint8_t, Interface==Mt6701Interface::I2C >, espp::BasePeripheral< uint8_t, Interface==qmi8658::Interface::I2C >, espp::BasePeripheral< uint8_t, UseAddress >, espp::I2cMasterDevice< uint8_t >, espp::AbiEncoder< T >, espp::BasePeripheral< RegisterAddressType, UseAddress, BigEndianRegisterAddress, BigEndianData >, espp::BatteryService, espp::BldcDriver, espp::BldcHaptics< M >, espp::BldcMotor< D, S, CS >, espp::BleGattServer, espp::Byte90, espp::ContinuousAdc, espp::Controller, espp::DeviceInfoService, espp::Display< Pixel >, espp::EncoderInput, espp::EspBox, espp::EspTimerCam, espp::EventManager, espp::FileSystem, espp::FtpClientSession, espp::FtpServer, espp::GenericAccessService, espp::GfpsService, espp::HeapMonitor, espp::HidService, espp::HighResolutionTimer, espp::I2c, espp::I2cMasterBus, espp::I2cMasterDevice< RegisterType >, espp::I2cSlaveDevice, espp::Interrupt, espp::Joystick, espp::KeypadInput, espp::Led, espp::LedStrip, espp::MatouchRotaryDisplay, espp::MotorGoMini, espp::Nvs, espp::NvsHandle, espp::OdriveAscii, espp::OneshotAdc, espp::Pid, espp::Ping, espp::PointerInput, espp::QtPy, espp::Rmt, espp::RtspClient, espp::RtspServer, espp::RtspSession, espp::RunQueue, espp::Socket, espp::SsRoundDisplay, espp::TDeck, espp::TDongleS3, espp::Task, espp::TaskMonitor, espp::Thermistor, espp::Timer, espp::TouchpadInput, espp::WifiAp, espp::WifiSta, espp::WroverKit, espp::WsS3Geek, espp::WsS3Lcd147, espp::WsS3Touch

Public Functions

inline const std::string &get_name() const

Get the name of the component

Note

This is the tag of the logger

Returns:

A const reference to the name of the component

inline void set_log_tag(const std::string_view &tag)

Set the tag for the logger

Parameters:

tag – The tag to use for the logger

inline espp::Logger::Verbosity get_log_level() const

Get the log level for the logger

See also

Logger::Verbosity

See also

Logger::set_verbosity

Returns:

The verbosity level of the logger

inline void set_log_level(espp::Logger::Verbosity level)

Set the log level for the logger

See also

Logger::Verbosity

See also

Logger::set_verbosity

Parameters:

level – The verbosity level to use for the logger

inline void set_log_verbosity(espp::Logger::Verbosity level)

Set the log verbosity for the logger

See also

set_log_level

See also

Logger::Verbosity

See also

Logger::set_verbosity

Note

This is a convenience method that calls set_log_level

Parameters:

level – The verbosity level to use for the logger

inline espp::Logger::Verbosity get_log_verbosity() const

Get the log verbosity for the logger

See also

get_log_level

See also

Logger::Verbosity

See also

Logger::get_verbosity

Note

This is a convenience method that calls get_log_level

Returns:

The verbosity level of the logger

inline void set_log_rate_limit(std::chrono::duration<float> rate_limit)

Set the rate limit for the logger

See also

Logger::set_rate_limit

Note

Only calls to the logger that have _rate_limit suffix will be rate limited

Parameters:

rate_limit – The rate limit to use for the logger