espressif/esp-nimble
1
0
Fork 0
mirror of https://github.com/espressif/esp-nimble.git synced 2026-10-03 05:37:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Fix sphinx build and cleanup for new repo

Browse Source
This commit is contained in:
Szymon Janc
2018-05-18 14:37:50 +02:00
parent bd65300bb7
commit 7a7b9dc704
8 changed files with 2451 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/ble_setup/ble_addr.rst
+3 -3
View File
@@ -3,7 +3,7 @@ Configure device address
A BLE device needs an address to do just about anything. For information
on the various types of Bluetooth addresses, see the `NimBLE Host
Identity Reference :doc:`<../../../network/ble/ble_hs/ble_hs_id/ble_hs_id>`.
Identity Reference :doc:`<../ble_hs/ble_hs_id/ble_hs_id>`.
There are several methods for assigning an address to a NimBLE device.
The available options are documented below:
@@ -52,9 +52,9 @@ Method 3: Configure a random address at runtime
Random addresses get configured through the NimBLE host. The following
two functions are used in random address configuration:
- :doc:`ble_hs_id_gen_rnd <../../../network/ble/ble_hs/ble_hs_id/functions/ble_hs_id_gen_rnd>`:
- :doc:`ble_hs_id_gen_rnd <../ble_hs/ble_hs_id/functions/ble_hs_id_gen_rnd>`:
Generates a new random address.
- :doc:`ble_hs_id_set_rnd <../../../network/ble/ble_hs/ble_hs_id/functions/ble_hs_id_set_rnd>`:
- :doc:`ble_hs_id_set_rnd <../ble_hs/ble_hs_id/functions/ble_hs_id_set_rnd>`:
Sets the device's random address.
For an example of how this is done, see the :doc:`<../../../os/tutorials/ibeacon>`.
docs/ble_setup/ble_sync_cb.rst
+1 -1
View File
@@ -38,7 +38,7 @@ form:
typedef void ble_hs_reset_fn(int reason);
The ``reason`` parameter is a :doc:`NimBLE host return
code <../../../network/ble/ble_hs/ble_hs_return_codes>`.
code <../ble_hs/ble_hs_return_codes>`.
Example
~~~~~~~