esp_wifi_set_rssi_threshold() function

Set RSSI threshold, if average rssi gets lower than threshold, WiFi task will post event WIFI_EVENT_STA_BSS_RSSI_LOW. @attention If the user wants to receive another WIFI_EVENT_STA_BSS_RSSI_LOW event after receiving one, this API needs to be called again with an updated/same RSSI threshold.

Syntax

Show:

Summary

Declaration

from esp_wifi.h:1378

esp_err_t esp_wifi_set_rssi_threshold(int32_t rssi);

Arguments

Argument

Description

rssi

threshold value in dbm between -100 to 10 Note that in some rare cases where signal strength is very strong, rssi values can be slightly positive.

Return value

- ESP_OK: succeed - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by esp_wifi_init - ESP_ERR_INVALID_ARG: invalid argument

Examples

References

from examples

esp_wifi_set_rssi_threshold() function

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle