Welcome to Foo’s documentation!

Defines

EXAMPLE_CHIP_ID: The chip ID, 0x58.

Enums

enum example_port_t

Example port number.

Values:

enumerator EXAMPLE_NUM_0: EXAMPLE port 0.

enumerator EXAMPLE_NUM_1: EXAMPLE port 1.

enumerator EXAMPLE_NUM_MAX: EXAMPLE port max.

Functions

esp_err_t func1(uint8_t arg1, uint8_t arg2)

A brief explanation for this function.

A longer explanation should be here.

#include <esp_log.h>

// include the header file.
#include <template-component.h>

#define TAG "example1"

void app_main(void)
{
    uint8_t foo = 1;
    uint8_t bar = 2;
    esp_err_t err = func1(foo, bar);

    ESP_LOGI(TAG, "result: %d", err);
}

Note

Please note that this is an example component

Warning

This is warning.

Parameters:

arg1 – [in] The first argument
arg2 – [in] The second argument

Returns:

ESP_OK: Successful
ESP_FAIL: Failure