esp-idf/components/wifi_provisioning/Kconfig

menu "Wi-Fi Provisioning Manager"

    config WIFI_PROV_SCAN_MAX_ENTRIES
        int "Max Wi-Fi Scan Result Entries"
        default 16
        range 1 255
        help
            This sets the maximum number of entries of Wi-Fi scan results that will be kept by the provisioning manager

    config WIFI_PROV_AUTOSTOP_TIMEOUT
        int "Provisioning auto-stop timeout"
        default 30
        range 5 600
        help
            Time (in seconds) after which the Wi-Fi provisioning manager will auto-stop after connecting to
            a Wi-Fi network successfully.

    config WIFI_PROV_BLE_BONDING
        bool
        prompt "Enable BLE bonding"
        depends on BT_ENABLED
        help
            This option is applicable only when provisioning transport is BLE.

    config WIFI_PROV_BLE_SEC_CONN
        bool
        prompt "Enable BLE Secure connection flag"
        depends on  BT_NIMBLE_ENABLED
        default y
        help
            Used to enable Secure connection support when provisioning transport is BLE.

    config WIFI_PROV_BLE_FORCE_ENCRYPTION
        bool
        prompt "Force Link Encryption during characteristic Read / Write"
        depends on BT_ENABLED
        help
            Used to enforce link encryption when attempting to read / write characteristic

    config WIFI_PROV_BLE_NOTIFY
        bool
        prompt "Add support for Notification for provisioning BLE descriptors"
        depends on BT_ENABLED
        help
            Used to enable support Notification in BLE descriptors of prov* characteristics

    config WIFI_PROV_KEEP_BLE_ON_AFTER_PROV
        bool "Keep BT on after provisioning is done"
        depends on BT_ENABLED
        select ESP_PROTOCOMM_KEEP_BLE_ON_AFTER_BLE_STOP

    config WIFI_PROV_DISCONNECT_AFTER_PROV
        bool "Terminate connection after provisioning is done"
        depends on WIFI_PROV_KEEP_BLE_ON_AFTER_PROV
        default y
        select ESP_PROTOCOMM_DISCONNECT_AFTER_BLE_STOP

    choice WIFI_PROV_STA_SCAN_METHOD
        bool "Wifi Provisioning Scan Method"
        default WIFI_PROV_STA_ALL_CHANNEL_SCAN
        config WIFI_PROV_STA_ALL_CHANNEL_SCAN
            bool "All Channel Scan"
            help
                    Scan will end after scanning the entire channel. This option is useful in Mesh WiFi Systems.
        config WIFI_PROV_STA_FAST_SCAN
            bool "Fast Scan"
            help
                    Scan will end after an AP matching with the SSID has been detected.
    endchoice
endmenu
wifi_provisioning : Added Wi-Fi Scan list feature to Provisioning Manager List of changes in components/wifi_provisioning: * Manager version is now v1.1 * .proto files and protocomm handler added for sending Wi-Fi scan command and receiving scan results * Implemented handlers for wifi_scan protocomm endpoint * Update manager context data structure to hold scan state and results * scheme_softap now runs Wi-Fi in APSTA mode * Wi-Fi is started in AP mode when provisioning is started. This is necessary for scan list to work * Docs updates with information about new wifi_scan endpoint List of changes in tools/esp_prov: * Added functions for sending and receiving protobuf messages compatible with wifi_scan protocomm endpoint * Added feature to display/refresh scan results and accept user selection at runtime * New functions: * get_version() : only returns the protocol version string * has_capability() : check is a capability is present according to proto-ver response * wifi_scan feature is provided only if the `wifi_scan` capability is present Other changes: * Replace recursive mutex with plain mutex * assert on return value of mutex give / take calls * replace all calls with macros ACQUIRE_LOCK and RELEASE_LOCK * some checks added in scanning related private APIs * free and nullify scanning context and state if service is stopped while ongoing scan 2019-04-23 02:48:28 -04:00			`menu "Wi-Fi Provisioning Manager"`

			`config WIFI_PROV_SCAN_MAX_ENTRIES`
			`int "Max Wi-Fi Scan Result Entries"`
			`default 16`
			`range 1 255`
			`help`
			`This sets the maximum number of entries of Wi-Fi scan results that will be kept by the provisioning manager`

wifi_prov_manager: Change the name of an internal timer handle to better reflect the purpose Signed-off-by: Piyush Shah <piyush@espressif.com> 2020-01-03 09:28:59 -05:00			`config WIFI_PROV_AUTOSTOP_TIMEOUT`
			`int "Provisioning auto-stop timeout"`
			`default 30`
			`range 5 600`
			`help`
			`Time (in seconds) after which the Wi-Fi provisioning manager will auto-stop after connecting to`
			`a Wi-Fi network successfully.`

Wifi_prov_mgr:Fix for ios device needs to do forget device 2021-09-08 03:41:33 -04:00			`config WIFI_PROV_BLE_BONDING`
			`bool`
			`prompt "Enable BLE bonding"`
			`depends on BT_ENABLED`
			`help`
			`This option is applicable only when provisioning transport is BLE.`
Merge branch 'bugfix/wifi_prov_mgr_conn_issue' into 'master' NimBLE: Fixed device disconnection issue of wifi prov mgr Closes IDF-4655 See merge request espressif/esp-idf!17236 2022-02-17 08:12:25 -05:00
			`config WIFI_PROV_BLE_SEC_CONN`
			`bool`
			`prompt "Enable BLE Secure connection flag"`
			`depends on BT_NIMBLE_ENABLED`
			`default y`
			`help`
			`Used to enable Secure connection support when provisioning transport is BLE.`

			`config WIFI_PROV_BLE_FORCE_ENCRYPTION`
			`bool`
			`prompt "Force Link Encryption during characteristic Read / Write"`
fix(nimble): Add notify characteristic flag support 2024-07-23 23:52:49 -04:00			`depends on BT_ENABLED`
Merge branch 'bugfix/wifi_prov_mgr_conn_issue' into 'master' NimBLE: Fixed device disconnection issue of wifi prov mgr Closes IDF-4655 See merge request espressif/esp-idf!17236 2022-02-17 08:12:25 -05:00			`help`
			`Used to enforce link encryption when attempting to read / write characteristic`

fix(nimble): Add notify characteristic flag support 2024-07-23 23:52:49 -04:00			`config WIFI_PROV_BLE_NOTIFY`
			`bool`
			`prompt "Add support for Notification for provisioning BLE descriptors"`
			`depends on BT_ENABLED`
			`help`
			`Used to enable support Notification in BLE descriptors of prov* characteristics`

Merge branch 'feature/rainmaker_BT_configurable' into 'master' Doc: Made bluetooth configurable after wifi provisioning is completed See merge request espressif/esp-idf!18014 2022-06-21 02:15:22 -04:00			`config WIFI_PROV_KEEP_BLE_ON_AFTER_PROV`
			`bool "Keep BT on after provisioning is done"`
			`depends on BT_ENABLED`
fix(protocomm): Remove the configuration check of wifi_provisioning for protocomm component 2023-09-17 22:49:03 -04:00			`select ESP_PROTOCOMM_KEEP_BLE_ON_AFTER_BLE_STOP`
Merge branch 'feature/rainmaker_BT_configurable' into 'master' Doc: Made bluetooth configurable after wifi provisioning is completed See merge request espressif/esp-idf!18014 2022-06-21 02:15:22 -04:00
			`config WIFI_PROV_DISCONNECT_AFTER_PROV`
			`bool "Terminate connection after provisioning is done"`
			`depends on WIFI_PROV_KEEP_BLE_ON_AFTER_PROV`
			`default y`
fix(protocomm): Remove the configuration check of wifi_provisioning for protocomm component 2023-09-17 22:49:03 -04:00			`select ESP_PROTOCOMM_DISCONNECT_AFTER_BLE_STOP`
Merge branch 'feature/rainmaker_BT_configurable' into 'master' Doc: Made bluetooth configurable after wifi provisioning is completed See merge request espressif/esp-idf!18014 2022-06-21 02:15:22 -04:00
Changed wifi provisioning scan method Signed-off-by: sanket.wadekar <sanket.wadekar@espressif.com> 2022-09-28 04:51:07 -04:00			`choice WIFI_PROV_STA_SCAN_METHOD`
			`bool "Wifi Provisioning Scan Method"`
			`default WIFI_PROV_STA_ALL_CHANNEL_SCAN`
			`config WIFI_PROV_STA_ALL_CHANNEL_SCAN`
			`bool "All Channel Scan"`
			`help`
			`Scan will end after scanning the entire channel. This option is useful in Mesh WiFi Systems.`
			`config WIFI_PROV_STA_FAST_SCAN`
			`bool "Fast Scan"`
			`help`
			`Scan will end after an AP matching with the SSID has been detected.`
			`endchoice`
wifi_provisioning : Added Wi-Fi Scan list feature to Provisioning Manager List of changes in components/wifi_provisioning: * Manager version is now v1.1 * .proto files and protocomm handler added for sending Wi-Fi scan command and receiving scan results * Implemented handlers for wifi_scan protocomm endpoint * Update manager context data structure to hold scan state and results * scheme_softap now runs Wi-Fi in APSTA mode * Wi-Fi is started in AP mode when provisioning is started. This is necessary for scan list to work * Docs updates with information about new wifi_scan endpoint List of changes in tools/esp_prov: * Added functions for sending and receiving protobuf messages compatible with wifi_scan protocomm endpoint * Added feature to display/refresh scan results and accept user selection at runtime * New functions: * get_version() : only returns the protocol version string * has_capability() : check is a capability is present according to proto-ver response * wifi_scan feature is provided only if the `wifi_scan` capability is present Other changes: * Replace recursive mutex with plain mutex * assert on return value of mutex give / take calls * replace all calls with macros ACQUIRE_LOCK and RELEASE_LOCK * some checks added in scanning related private APIs * free and nullify scanning context and state if service is stopped while ongoing scan 2019-04-23 02:48:28 -04:00			`endmenu`