ESP-IDF + 0/5 examples

Symbols

Files

Summary Syntax Arguments Related References

SourceVuESP-IDF Framework and ExamplesESP-IDFtwai_driver_install()

twai_driver_install() function

Install TWAI driver This function installs the TWAI driver using three configuration structures. The required memory is allocated and the TWAI driver is placed in the stopped state after running this function.

Syntax

Show:

Summary

Declaration

Definition

from twai.h:164

esp_err_t twai_driver_install(const twai_general_config_t *g_config, const twai_timing_config_t *t_config, const twai_filter_config_t *f_config);

Implemented in twai.c:538

Arguments

Argument

Description

g_config

General configuration structure

t_config

Timing configuration structure

f_config

Filter configuration structure

Return value

- ESP_OK: Successfully installed TWAI driver - ESP_ERR_INVALID_ARG: Arguments are invalid, e.g. invalid clock source, invalid quanta resolution - ESP_ERR_NO_MEM: Insufficient memory - ESP_ERR_INVALID_STATE: Driver is already installed

Notes

Macro initializers are available for the configuration structures (see documentation) To reinstall the TWAI driver, call twai_driver_uninstall() first

Examples

twai_driver_install() is referenced by 5 libraries and example projects:

References

from examples

twai_driver_install() function

Syntax

Arguments

Return value

Notes

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle

twai_driver_install() function

Syntax

Arguments

Return value

Notes

Related Functions

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle