esp_wifi_set_inactive_time() function

Set the inactive time of the STA or AP @attention 1. For Station, If the station does not receive a beacon frame from the connected SoftAP during the inactive time, disconnect from SoftAP. Default 6s. @attention 2. For SoftAP, If the softAP doesn't receive any data from the connected STA during inactive time, the softAP will force deauth the STA. Default is 300s. @attention 3. The inactive time configuration is not stored into flash

Syntax

Show:

Summary

Declaration

from esp_wifi.h:1337

esp_err_t esp_wifi_set_inactive_time(wifi_interface_t ifx, uint16_t sec);

Arguments

Argument

Description

ifx

interface to be configured.

sec

Inactive time. Unit seconds.

Return value

- ESP_OK: succeed - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by esp_wifi_init - ESP_ERR_WIFI_NOT_STARTED: WiFi is not started by esp_wifi_start - ESP_ERR_INVALID_ARG: invalid argument, For Station, if sec is less than 3. For SoftAP, if sec is less than 10.

Examples

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

power_save sample

References

from 0/1 examples

Code

Location

esp_err_t esp_wifi_set_inactive_time(wifi_interface_t ifx, uint16_t sec);

esp_wifi.h:1337

esp_wifi_set_inactive_time() function

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle