meshx_platform.h File Reference

Platform abstraction layer for MeshX. More...

#include "meshx_err.h"
#include "meshx_platform_ble_mesh.h"
#include "interface/ble_mesh/meshx_ble_mesh_cmn_def.h"

Go to the source code of this file.

Functions
meshx_err_t	meshx_platform_init (void)
	Initializes the MeshX platform.
void	meshx_platform_reset (void)
	Resets the MeshX platform. This function performs a system reset, restarting the platform.
void	meshx_platform_serial_write (const uint8_t *data, uint16_t len)
	Writes data to the serial interface.
meshx_err_t	meshx_platform_serial_init (void)
	Initializes the serial interface for communication.
int32_t	meshx_platform_serial_read (uint8_t *data, uint16_t len)
	Reads data from the serial interface.
void	meshx_platform_console_write (const char *data, uint16_t len)
	Writes data to the console interface.
int32_t	meshx_platform_console_read (uint8_t *data, uint16_t len)
	Reads data from the console interface.
meshx_err_t	meshx_platform_console_init (void)
	Initializes the console interface.

Detailed Description

Platform abstraction layer for MeshX.

This header provides initialization functions for the MeshX platform and its Bluetooth subsystem.

Function Documentation

meshx_platform_console_init()

meshx_err_t meshx_platform_console_init

(

void

)

Initializes the console interface.

Returns

meshx_err_t Returns MESHX_OK on success, or an appropriate error code.

{
#if CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG
    /* Disable buffering on stdin and stdout */
    setvbuf(stdin, NULL, _IONBF, 0);
    setvbuf(stdout, NULL, _IONBF, 0);
 
    /* Install USB-SERIAL-JTAG driver for interrupt-driven reads */
    usb_serial_jtag_driver_config_t usb_serial_jtag_config = USB_SERIAL_JTAG_DRIVER_CONFIG_DEFAULT();
    esp_err_t ret = usb_serial_jtag_driver_install(&usb_serial_jtag_config);
    if (ret != ESP_OK && ret != ESP_ERR_INVALID_STATE) return MESHX_ERR_PLAT;
 
    /* Tell VFS to use USB-SERIAL-JTAG driver */
    usb_serial_jtag_vfs_use_driver();
    ESP_LOGD("MESHX_PLAT", "Console initialized via USB Serial JTAG");
 
#elif CONFIG_ESP_CONSOLE_UART
    if (!uart_is_driver_installed(CONFIG_MESHX_CONSOLE_UART_PORT)) {
        uart_config_t uart_config = {
            .baud_rate = 115200,
            .data_bits = UART_DATA_8_BITS,
            .parity    = UART_PARITY_DISABLE,
            .stop_bits = UART_STOP_BITS_1,
            .flow_ctrl = UART_HW_FLOWCTRL_DISABLE,
            .source_clk = UART_SCLK_DEFAULT,
        };
        ESP_ERROR_CHECK(uart_driver_install(CONFIG_MESHX_CONSOLE_UART_PORT, 1024, 0, 0, NULL, 0));
        ESP_ERROR_CHECK(uart_param_config(CONFIG_MESHX_CONSOLE_UART_PORT, &uart_config));
        ESP_LOGD("MESHX_PLAT", "Console initialized via UART%d", CONFIG_MESHX_CONSOLE_UART_PORT);
    }
#endif
    return MESHX_SUCCESS;
}

meshx_platform_console_read()

int32_t meshx_platform_console_read	(	uint8_t *	data,
		uint16_t	len )

Reads data from the console interface.

Parameters

[out]	data	Pointer to the data buffer.
[in]	len	Length of the data to read.

Returns

int32_t Number of bytes read, or negative error code.

{
#if CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG
    return usb_serial_jtag_read_bytes(data, len, 10 / portTICK_PERIOD_MS);
#elif CONFIG_ESP_CONSOLE_UART
    return uart_read_bytes(CONFIG_MESHX_CONSOLE_UART_PORT, data, len, 10 / portTICK_PERIOD_MS);
#else
    return -1;
#endif
}

meshx_platform_console_write()

void meshx_platform_console_write	(	const char *	data,
		uint16_t	len )

Writes data to the console interface.

Parameters

[in]	data	Pointer to the data buffer.
[in]	len	Length of the data to write.

{
#if CONFIG_ESP_CONSOLE_USB_SERIAL_JTAG
    usb_serial_jtag_write_bytes(data, len, portMAX_DELAY);
#elif CONFIG_ESP_CONSOLE_UART
    uart_write_bytes(CONFIG_MESHX_CONSOLE_UART_PORT, data, len);
#else
    // Fallback to standard printf/fwrite if needed
    fwrite(data, 1, len, stdout);
#endif
}

meshx_platform_init()

meshx_err_t meshx_platform_init

(

void

)

Initializes the MeshX platform.

This function sets up the necessary hardware and software components required for the MeshX platform to function correctly.

Returns

meshx_err_t Returns MESHX_OK on success, or an appropriate error code.

Initializes the MeshX platform.

This function sets up the necessary components and configurations required for the MeshX platform to operate on the ESP32. It ensures that the platform is ready for use by other components of the MeshX system.

Returns

• MESHX_OK on successful initialization.
• Appropriate error code of type meshx_err_t on failure.

{
    esp_err_t err = ESP_OK;
    /* Initialize NVS flash */
    err = nvs_flash_init();
    if (err == ESP_ERR_NVS_NO_FREE_PAGES)
    {
        ESP_ERROR_CHECK(nvs_flash_erase());
        err = nvs_flash_init();
    }
    if(err)
        return MESHX_ERR_PLAT;
 
    /* Initialize Serial interface by default */
    meshx_platform_serial_init();
 
    /* Initialize Console interface by default for early logging */
    meshx_platform_console_init();
 
    /* Set log level for BLE Mesh */
    esp_log_level_set("BLE_MESH", ESP_LOG_ERROR);
 
    return MESHX_SUCCESS;
}

meshx_platform_reset()

void meshx_platform_reset

(

void

)

Resets the MeshX platform. This function performs a system reset, restarting the platform.

{
    esp_restart();
}

meshx_platform_serial_init()

meshx_err_t meshx_platform_serial_init

(

void

)

Initializes the serial interface for communication.

Returns

meshx_err_t Returns MESHX_OK on success, or an appropriate error code.

Initializes the serial interface for communication.

This function initializes the serial interface for the MeshX platform. It configures the UART port, sets the baud rate, and enables the UART.

Returns

• MESHX_OK on successful initialization.
• Appropriate error code of type meshx_err_t on failure.

{
    uart_config_t uart_config = {
        .baud_rate = CONFIG_MXSP_UART_BAUD,
        .data_bits = UART_DATA_8_BITS,
        .parity    = UART_PARITY_DISABLE,
        .stop_bits = UART_STOP_BITS_1,
        .flow_ctrl = UART_HW_FLOWCTRL_DISABLE,
        .source_clk = UART_SCLK_DEFAULT,
    };
    int intr_alloc_flags = 0;
 
    esp_err_t ret = uart_driver_install(CONFIG_MXSP_UART_PORT, 1024 * 2, 0, 0, NULL, intr_alloc_flags);
    if (ret != ESP_OK) return MESHX_ERR_PLAT;
 
    ret = uart_param_config(CONFIG_MXSP_UART_PORT, &uart_config);
    if (ret != ESP_OK) return MESHX_ERR_PLAT;
 
    ret = uart_set_pin(CONFIG_MXSP_UART_PORT, CONFIG_MXSP_UART_TX_PIN, CONFIG_MXSP_UART_RX_PIN, UART_PIN_NO_CHANGE, UART_PIN_NO_CHANGE);
    if (ret != ESP_OK) return MESHX_ERR_PLAT;
 
    return MESHX_SUCCESS;
}

meshx_platform_serial_read()

int32_t meshx_platform_serial_read	(	uint8_t *	data,
		uint16_t	len )

Reads data from the serial interface.

Parameters

[out]	data	Pointer to the data buffer.
[in]	len	Length of the data to read.

Returns

int32_t Number of bytes read, or negative error code.

{
    return uart_read_bytes(CONFIG_MXSP_UART_PORT, data, len, 20 / portTICK_PERIOD_MS);
}

meshx_platform_serial_write()

void meshx_platform_serial_write	(	const uint8_t *	data,
		uint16_t	len )

Writes data to the serial interface.

Parameters

[in]	data	Pointer to the data buffer.
[in]	len	Length of the data to write.

{
    uart_write_bytes(CONFIG_MXSP_UART_PORT, (const char *)data, len);
}