PL::BlackBoxUartConfiguration class

class BlackBoxUartConfiguration : public PL::BlackBoxHardwareInterfaceConfiguration

BlackBox UART configuration.

Public Functions

BlackBoxUartConfiguration(std::shared_ptr<Uart> uart, std::string nvsNamespaceName)

Creates a BlackBox UART configuration.

Parameters:

• uart – UART

• nvsNamespaceName – NVS namespace name

virtual void Load() override

Loads the configuration.

virtual void Save() override

Saves the configuration.

virtual void Apply() override

Applies the configuration to the hardware interface.

std::shared_ptr<HardwareInterface> GetHardwareInterface()

Gets the hardware interface.

Returns:

hardware interface

virtual esp_err_t Lock(TickType_t timeout = portMAX_DELAY) override

Locks the object.

Parameters:

timeout – timeout in FreeRTOS ticks

Returns:

error code

virtual esp_err_t Unlock() override

Unlocks the object.

Returns:

error code

virtual void Erase() override

Erases the configuration.

Public Members

BlackBoxConfigurationParameter<uint32_t> baudRate

baud rate parameter

BlackBoxConfigurationParameter<uint16_t> dataBits

data bits parameter

BlackBoxConfigurationParameter<UartParity> parity

parity parameter

BlackBoxConfigurationParameter<UartStopBits> stopBits

stop bits parameter

BlackBoxConfigurationParameter<UartFlowControl> flowControl

flow control parameter

BlackBoxConfigurationParameter<bool> enabled = BlackBoxConfigurationParameter<bool>(true)

enabled parameter

Public Static Attributes

static const std::string baudRateNvsKey

baud rate parameter NVS key

static const std::string dataBitsNvsKey

data bits parameter NVS key

static const std::string parityNvsKey

parity parameter NVS key

static const std::string stopBitsNvsKey

stop bits parameter NVS key

static const std::string flowControlNvsKey

flow control parameter NVS key

static const std::string enabledNvsKey

enabled parameter NVS key