Function esp_idf_sys::esp_wifi_set_country
source · pub unsafe extern "C" fn esp_wifi_set_country(
country: *const wifi_country_t,
) -> esp_err_t
Expand description
@brief configure country info
@attention 1. It is discouraged to call this API since this doesn’t validate the per-country rules, it’s up to the user to fill in all fields according to local regulations. Please use esp_wifi_set_country_code instead. @attention 2. The default country is “01” (world safe mode) {.cc=“01”, .schan=1, .nchan=11, .policy=WIFI_COUNTRY_POLICY_AUTO}. @attention 3. The third octet of country code string is one of the following: ’ ’, ‘O’, ‘I’, ‘X’, otherwise it is considered as ’ ’. @attention 4. When the country policy is WIFI_COUNTRY_POLICY_AUTO, the country info of the AP to which the station is connected is used. E.g. if the configured country info is {.cc=“US”, .schan=1, .nchan=11} and the country info of the AP to which the station is connected is {.cc=“JP”, .schan=1, .nchan=14} then the country info that will be used is {.cc=“JP”, .schan=1, .nchan=14}. If the station disconnected from the AP the country info is set back to the country info of the station automatically, {.cc=“US”, .schan=1, .nchan=11} in the example. @attention 5. When the country policy is WIFI_COUNTRY_POLICY_MANUAL, then the configured country info is used always. @attention 6. When the country info is changed because of configuration or because the station connects to a different external AP, the country IE in probe response/beacon of the soft-AP is also changed. @attention 7. The country configuration is stored into flash. @attention 8. When this API is called, the PHY init data will switch to the PHY init data type corresponding to the country info.
@param country the configured country info
@return
- ESP_OK: succeed
- ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by esp_wifi_init
- ESP_ERR_INVALID_ARG: invalid argument