twai_read_alerts() function

Read TWAI driver alerts This function will read the alerts raised by the TWAI driver. If no alert has been issued when this function is called, this function will block until an alert occurs or until it timeouts.

Syntax

Show:

Summary

Declaration

Definition

from twai.h:387

esp_err_t twai_read_alerts(uint32_t *alerts, TickType_t ticks_to_wait);

Implemented in twai.c:778

Arguments

Argument

Description

alerts

Bit field of raised alerts (see documentation for alert flags)

ticks_to_wait

Number of FreeRTOS ticks to block for alert

Return value

- ESP_OK: Alerts read - ESP_ERR_TIMEOUT: Timed out waiting for alerts - ESP_ERR_INVALID_ARG: Arguments are invalid - ESP_ERR_INVALID_STATE: TWAI driver is not installed

Notes

Multiple alerts can be raised simultaneously. The application should check for all alerts that have been enabled.

Examples

twai_read_alerts() is referenced by 1 libraries and example projects:

References

from examples

twai_read_alerts() function

Syntax

Arguments

Return value

Notes

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle