OVMS3-idf/docs/en/api-reference/bluetooth/esp_blufi.rst

BLUFI API
=========

Overview
--------
BLUFI is a profile based GATT to config ESP32 WIFI to connect/disconnect AP or setup a softap and etc.
Use should concern these things:

1. The event sent from profile. Then you need to do something as the event indicate.
2. Security reference. You can write your own Security functions such as symmetrical encryption/decryption and checksum functions. Even you can define the "Key Exchange/Negotiation" procedure.

Application Example
-------------------

Check :example:`bluetooth/bluedroid/ble` folder in ESP-IDF examples, which contains the following application:

* This is the BLUFI demo. This demo can set ESP32's wifi to softap/station/softap&station mode and config wifi connections - :example:`bluetooth/bluedroid/ble/blufi`

API Reference
-------------

.. include-build-file:: inc/esp_blufi_api.inc
component/bt : new blufi 1. new blufi protocol 2. new blufi demo 3. support security 4. support sta/ap/sta_ap 5. support wpa-enterprise 2016-12-28 04:02:43 +00:00			`BLUFI API`
			`=========`

			`Overview`
			`--------`
			`BLUFI is a profile based GATT to config ESP32 WIFI to connect/disconnect AP or setup a softap and etc.`
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130. 2017-05-02 08:36:01 +00:00			`Use should concern these things:`

component/bt: bug fix of lack of checking bluetooth stack status inside API functions 2017-01-11 03:04:41 +00:00			`1. The event sent from profile. Then you need to do something as the event indicate.`
component bt:Added the create attribute table method to the new API 2016-12-23 16:28:47 +00:00			`2. Security reference. You can write your own Security functions such as symmetrical encryption/decryption and checksum functions. Even you can define the "Key Exchange/Negotiation" procedure.`
component/bt : new blufi 1. new blufi protocol 2. new blufi demo 3. support security 4. support sta/ap/sta_ap 5. support wpa-enterprise 2016-12-28 04:02:43 +00:00
			`Application Example`
			`-------------------`

Bluetooth examples restructuring The existing Bluetooth examples are split as: 1. examples/bluetooth/bluedroid - Bluedroid Host (BT + BLE) examples a. examples/bluetooth/bluedroid/classic_bt - Classic BT examples b. examples/bluetooth/bluedroid/ble - BLE examples c. examples/bluetooth/bluedroid/coex - Classic BT and BLE coex examples d. examples/bluetooth/bluedroid/hci - VHCI and HCI UART examples i. Rename ble_adv to controller_vhci_ble_adv and move it in hci folder 2. examples/bluetooth/nimble - NimBLE BLE Host + NimBLE Mesh examples 3. examples/bluetooth/esp_ble_mesh - ESP BLE Mesh examples 4. Update documentation references 2019-07-01 11:21:57 +00:00			Check :example:`bluetooth/bluedroid/ble` folder in ESP-IDF examples, which contains the following application:
component/bt : new blufi 1. new blufi protocol 2. new blufi demo 3. support security 4. support sta/ap/sta_ap 5. support wpa-enterprise 2016-12-28 04:02:43 +00:00
Bluetooth examples restructuring The existing Bluetooth examples are split as: 1. examples/bluetooth/bluedroid - Bluedroid Host (BT + BLE) examples a. examples/bluetooth/bluedroid/classic_bt - Classic BT examples b. examples/bluetooth/bluedroid/ble - BLE examples c. examples/bluetooth/bluedroid/coex - Classic BT and BLE coex examples d. examples/bluetooth/bluedroid/hci - VHCI and HCI UART examples i. Rename ble_adv to controller_vhci_ble_adv and move it in hci folder 2. examples/bluetooth/nimble - NimBLE BLE Host + NimBLE Mesh examples 3. examples/bluetooth/esp_ble_mesh - ESP BLE Mesh examples 4. Update documentation references 2019-07-01 11:21:57 +00:00			* This is the BLUFI demo. This demo can set ESP32's wifi to softap/station/softap&station mode and config wifi connections - :example:`bluetooth/bluedroid/ble/blufi`
component/bt : new blufi 1. new blufi protocol 2. new blufi demo 3. support security 4. support sta/ap/sta_ap 5. support wpa-enterprise 2016-12-28 04:02:43 +00:00
			`API Reference`
			`-------------`

docs: add new top-level docs builder that builds docs for a single chip 2019-11-13 03:46:16 +00:00			`.. include-build-file:: inc/esp_blufi_api.inc`
component/bt : new blufi 1. new blufi protocol 2. new blufi demo 3. support security 4. support sta/ap/sta_ap 5. support wpa-enterprise 2016-12-28 04:02:43 +00:00